@rimori/client 2.5.28-next.5 → 2.5.28-next.7

package/README.md

@@ -140,7 +140,7 @@ Helpers:
 The `client.ai` controller surfaces AI capabilities:
 
 - `getText(messages, tools?)` – chat completion (string result).
-- `getSteamedText(messages, onMessage, tools?)` – streamed responses.
+- `getStreamedText(messages, onMessage, tools?)` – streamed responses.
 - `getObject(request)` – structured JSON generation.
 - `getVoice(text, voice?, speed?, language?)` – text-to-speech (returns `Blob`).
 - `getTextFromVoice(file)` – speech-to-text transcription.

package/dist/plugin/module/AIModule.d.ts

@@ -35,24 +35,6 @@ export interface Message {
     toolCalls?: ToolInvocation[];
 }
 export type OnLLMResponse = (id: string, response: string, finished: boolean, toolInvocations?: ToolInvocation[]) => void;
-export interface ObjectRequest {
-    /**
-     * The tools that the AI can use.
-     */
-    tool: AIObjectTool;
-    /**
-     * High level instructions for the AI to follow. Behaviour, tone, restrictions, etc.
-     * Example: "Act like a recipe writer."
-     */
-    /** @deprecated Use server-side prompt definitions (prompt + variables) instead of building requests client-side. */
-    behaviour?: string;
-    /**
-     * The specific instruction for the AI to follow.
-     * Example: "Generate a recipe using chicken, rice and vegetables."
-     */
-    /** @deprecated Use server-side prompt definitions (prompt + variables) instead of building requests client-side. */
-    instructions: string;
-}
 /**
  * Controller for AI-related operations.
  * Provides access to text generation, voice synthesis, and object generation.
@@ -88,24 +70,41 @@ export declare class AIModule {
     setOnRateLimited(cb: (exercisesRemaining: number) => void): void;
     /**
      * Generate text from messages using AI.
-     * @param messages The messages to generate text from.
-     * @param tools Optional tools to use for generation.
-     * @param cache Whether to cache the result (default: false).
-     * @param model The model to use for generation.
+     * @param params.messages The messages to generate text from.
+     * @param params.tools Optional tools to use for generation.
+     * @param params.cache Whether to cache the result (default: false).
+     * @param params.model The model to use for generation.
+     * @param params.prompt Server-side prompt name (e.g. 'writing.analysis').
+     * @param params.variables Variables for the server-side prompt template.
      * @returns The generated text.
      */
-    getText(messages: Message[], tools?: Tool[], cache?: boolean, model?: string): Promise<string>;
+    getText(params: {
+        messages: Message[];
+        tools?: Tool[];
+        cache?: boolean;
+        model?: string;
+        prompt?: string;
+        variables?: Record<string, any>;
+    }): Promise<string>;
     /**
      * Stream text generation from messages using AI.
-     * @param messages The messages to generate text from.
-     * @param onMessage Callback for each message chunk.
-     * @param tools Optional tools to use for generation.
-     * @param cache Whether to cache the result (default: false).
-     * @param model The model to use for generation.
+     * @param params.messages The messages to generate text from.
+     * @param params.onMessage Callback for each message chunk.
+     * @param params.tools Optional tools to use for generation.
+     * @param params.cache Whether to cache the result (default: false).
+     * @param params.model The model to use for generation.
+     * @param params.prompt Server-side prompt name (e.g. 'writing.analysis').
+     * @param params.variables Variables for the server-side prompt template.
      */
-    getSteamedText(messages: Message[], onMessage: OnLLMResponse, tools?: Tool[], cache?: boolean, model?: string, 
-    /** @deprecated Use uuid variable with resolver 'knowledgeEntry' in prompt definitions instead. */
-    knowledgeId?: string, prompt?: string, variables?: Record<string, any>): Promise<string>;
+    getStreamedText(params: {
+        messages: Message[];
+        onMessage: OnLLMResponse;
+        tools?: Tool[];
+        cache?: boolean;
+        model?: string;
+        prompt?: string;
+        variables?: Record<string, any>;
+    }): Promise<string>;
     /**
      * Generate voice audio from text using AI.
      * @param text The text to convert to voice.
@@ -123,8 +122,6 @@ export declare class AIModule {
      * @returns The transcribed text.
      */
     getTextFromVoice(file: Blob, language?: Language): Promise<string>;
-    /** @deprecated Used by legacy client-side prompt path. Will be removed once all plugins migrate to server-side prompt definitions. */
-    private getChatMessage;
     /**
      * Generate a structured object from a request using AI.
      * @param request.cache Whether to cache the result (default: false).
@@ -135,17 +132,9 @@ export declare class AIModule {
      * @returns The generated object.
      */
     getObject<T = any>(params: {
-        /** @deprecated Use prompt + variables instead of client-side system prompts. */
-        systemPrompt?: string;
-        /** @deprecated Use prompt + variables instead. Schema is loaded server-side from the prompt definition. */
-        responseSchema?: AIObjectTool;
-        /** @deprecated Use prompt + variables instead of client-side user prompts. */
-        userPrompt?: string;
         cache?: boolean;
         tools?: Tool[];
         model?: string;
-        /** @deprecated Use uuid variable with resolver 'knowledgeEntry' in prompt definitions instead. */
-        knowledgeId?: string;
         prompt?: string;
         variables?: Record<string, any>;
     }): Promise<T>;
@@ -159,18 +148,10 @@ export declare class AIModule {
      * @param request.variables Variables for the server-side prompt template.
      */
     getStreamedObject<T = any>(params: {
-        /** @deprecated Use prompt + variables instead of client-side system prompts. */
-        systemPrompt?: string;
-        /** @deprecated Use prompt + variables instead. Schema is loaded server-side from the prompt definition. */
-        responseSchema?: AIObjectTool;
-        /** @deprecated Use prompt + variables instead of client-side user prompts. */
-        userPrompt?: string;
         onResult: OnStreamedObjectResult<T>;
         cache?: boolean;
         tools?: Tool[];
         model?: string;
-        /** @deprecated Use uuid variable with resolver 'knowledgeEntry' in prompt definitions instead. */
-        knowledgeId?: string;
         prompt?: string;
         variables?: Record<string, any>;
     }): Promise<T>;

package/dist/plugin/module/AIModule.js

@@ -75,42 +75,47 @@ export class AIModule {
     }
     /**
      * Generate text from messages using AI.
-     * @param messages The messages to generate text from.
-     * @param tools Optional tools to use for generation.
-     * @param cache Whether to cache the result (default: false).
-     * @param model The model to use for generation.
+     * @param params.messages The messages to generate text from.
+     * @param params.tools Optional tools to use for generation.
+     * @param params.cache Whether to cache the result (default: false).
+     * @param params.model The model to use for generation.
+     * @param params.prompt Server-side prompt name (e.g. 'writing.analysis').
+     * @param params.variables Variables for the server-side prompt template.
      * @returns The generated text.
      */
-    getText(messages_1, tools_1) {
-        return __awaiter(this, arguments, void 0, function* (messages, tools, cache = false, model) {
+    getText(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { messages, tools, cache = false, model, prompt, variables } = params;
             const { result } = yield this.streamObject({
                 cache,
                 tools,
                 model,
                 messages,
+                prompt,
+                variables,
             });
             return result;
         });
     }
     /**
      * Stream text generation from messages using AI.
-     * @param messages The messages to generate text from.
-     * @param onMessage Callback for each message chunk.
-     * @param tools Optional tools to use for generation.
-     * @param cache Whether to cache the result (default: false).
-     * @param model The model to use for generation.
+     * @param params.messages The messages to generate text from.
+     * @param params.onMessage Callback for each message chunk.
+     * @param params.tools Optional tools to use for generation.
+     * @param params.cache Whether to cache the result (default: false).
+     * @param params.model The model to use for generation.
+     * @param params.prompt Server-side prompt name (e.g. 'writing.analysis').
+     * @param params.variables Variables for the server-side prompt template.
      */
-    getSteamedText(messages_1, onMessage_1, tools_1) {
-        return __awaiter(this, arguments, void 0, function* (messages, onMessage, tools, cache = false, model, 
-        /** @deprecated Use uuid variable with resolver 'knowledgeEntry' in prompt definitions instead. */
-        knowledgeId, prompt, variables) {
+    getStreamedText(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { messages, onMessage, tools, cache = false, model, prompt, variables, } = params;
             const messageId = Math.random().toString(36).substring(3);
             const { result } = yield this.streamObject({
                 cache,
                 tools,
                 model,
                 messages,
-                knowledgeId,
                 prompt,
                 variables,
                 onResult: ({ result }) => onMessage(messageId, result, false),
@@ -179,14 +184,6 @@ export class AIModule {
             });
         });
     }
-    /** @deprecated Used by legacy client-side prompt path. Will be removed once all plugins migrate to server-side prompt definitions. */
-    getChatMessage(systemPrompt, userPrompt) {
-        const messages = [{ role: 'system', content: systemPrompt }];
-        if (userPrompt) {
-            messages.push({ role: 'user', content: userPrompt });
-        }
-        return messages;
-    }
     /**
      * Generate a structured object from a request using AI.
      * @param request.cache Whether to cache the result (default: false).
@@ -198,14 +195,12 @@ export class AIModule {
      */
     getObject(params) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { systemPrompt, responseSchema, userPrompt, cache = false, tools = [], model = undefined, knowledgeId, prompt, variables, } = params;
+            const { cache = false, tools = [], model = undefined, prompt, variables } = params;
             return yield this.streamObject({
-                responseSchema,
-                messages: systemPrompt ? this.getChatMessage(systemPrompt, userPrompt) : [],
+                messages: [],
                 cache,
                 tools,
                 model,
-                knowledgeId,
                 prompt,
                 variables,
             });
@@ -222,15 +217,13 @@ export class AIModule {
      */
     getStreamedObject(params) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { systemPrompt, responseSchema, userPrompt, onResult, cache = false, tools = [], model = undefined, knowledgeId, prompt, variables, } = params;
+            const { onResult, cache = false, tools = [], model = undefined, prompt, variables } = params;
             return yield this.streamObject({
-                responseSchema,
-                messages: systemPrompt ? this.getChatMessage(systemPrompt, userPrompt) : [],
+                messages: [],
                 onResult,
                 cache,
                 tools,
                 model,
-                knowledgeId,
                 prompt,
                 variables,
             });
@@ -239,7 +232,7 @@ export class AIModule {
     streamObject(params) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e;
-            const { messages, responseSchema, onResult = () => null, cache = false, tools = [], model = undefined, knowledgeId, prompt, variables, } = params;
+            const { messages, onResult = () => null, cache = false, tools = [], model = undefined, prompt, variables, } = params;
             const chatMessages = messages.map((message, index) => (Object.assign(Object.assign({}, message), { id: `${index + 1}` })));
             const payload = {
                 cache,
@@ -247,15 +240,11 @@ export class AIModule {
                 stream: true,
                 messages: chatMessages,
                 model,
-                knowledge_id: knowledgeId,
                 session_token_id: (_a = this.sessionTokenId) !== null && _a !== void 0 ? _a : undefined,
             };
             if (prompt) {
                 payload.prompt = { name: this.resolvePromptName(prompt), variables: variables !== null && variables !== void 0 ? variables : {} };
             }
-            if (responseSchema) {
-                payload.responseSchema = responseSchema;
-            }
             const response = yield fetch(`${this.backendUrl}/ai/llm`, {
                 body: JSON.stringify(payload),
                 method: 'POST',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rimori/client",
-  "version": "2.5.28-next.5",
+  "version": "2.5.28-next.7",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "repository": {