iobroker.assistant 1.0.2 → 1.0.3

package/build/main.js

@@ -46,6 +46,7 @@ const timers_1 = require("./lib/timers");
 const alarms_1 = require("./lib/alarms");
 const memory_1 = require("./lib/memory");
 const weather_1 = require("./lib/weather");
+const journal_1 = require("./lib/journal");
 const localLlm_1 = require("./lib/localLlm");
 const credentials_1 = require("./lib/credentials");
 const context_1 = require("./lib/context");
@@ -187,6 +188,8 @@ class Assistant extends adapter_core_1.Adapter {
     /** Set once `onReady` initialised the pipeline — with or without a cloud {@link agent}. */
     ready = false;
     mcp = null;
+    /** Who asked what and how it was answered (admin chat); null until `onReady` read the config. */
+    journal = null;
     /** Short-TTL cache for the expensive device/room/function listings; invalidated on enum changes. */
     listCache = null;
     /** Cache of a `<base>.SET` level state id → its writable boolean sibling switch (`<base>.ON_SET`/`.ON`), or ''. */
@@ -270,6 +273,7 @@ class Assistant extends adapter_core_1.Adapter {
         const provider = cfg.provider || 'openai';
         const localOnly = provider === 'none';
         const apiKey = localOnly ? '' : (0, llm_1.effectiveApiKey)(cfg.provider, await (0, credentials_1.resolveApiKey)(this, cfg));
+        await this.setupJournal();
         if (!localOnly && !apiKey) {
             this.log.warn(cfg.credentialType === 'manager'
                 ? 'No credential selected (manager mode) — pick an API-key credential in the adapter settings.'
@@ -278,12 +282,12 @@ class Assistant extends adapter_core_1.Adapter {
             return;
         }
         try {
-            this.mcp = await (0, mcp_server_1.createInProcessMcp)({
+            this.mcp = this.journalMcp(await (0, mcp_server_1.createInProcessMcp)({
                 adapter: this,
                 language: this.language,
                 allowSetState: cfg.allowWriteStates,
                 allowObjectChange: cfg.allowObjectChange,
-            });
+            }));
             this.listCache = new tools_1.ListCache();
             const { tools, denied } = await (0, tools_1.buildMcpTools)(this.mcp, cfg, this.listCache, (id, fb) => this.resolveDeviceName(id, fb));
             // Let the cloud LLM handle timers/alarms too (for phrasings the rule-based NLU misses).
@@ -314,7 +318,7 @@ class Assistant extends adapter_core_1.Adapter {
                     baseUrl: prov.baseUrl,
                     systemPrompt: cfg.systemPrompt || '',
                     maxTokens: cfg.maxTokens || 1024,
-                    tools,
+                    tools: tools.map(t => this.journalTool(t)),
                     log: this.log,
                 });
             }
@@ -403,7 +407,7 @@ class Assistant extends adapter_core_1.Adapter {
                 language,
                 stt,
                 tts,
-                answer: question => this.answer(question, 'wyoming'),
+                answer: (question, sttMs) => this.answer(question, 'wyoming', { transport: 'wyoming', sttMs }),
                 getHints: () => this.buildSttHints(),
                 log: this.log,
             });
@@ -463,7 +467,12 @@ class Assistant extends adapter_core_1.Adapter {
             language,
             stt,
             tts,
-            answer: (question, origin) => this.answerVoice(question, origin.device),
+            answer: (question, origin) => this.answerVoice(question, origin.device, {
+                transport: 'esphome',
+                room: origin.room,
+                wakeWord: origin.wakeWord,
+                sttMs: origin.sttMs,
+            }),
             getHints: () => this.buildSttHints(),
             media: this.media,
             mediaHost: (cfg.esphomeMediaHost || '').trim(),
@@ -536,7 +545,7 @@ class Assistant extends adapter_core_1.Adapter {
                 language,
                 stt,
                 tts,
-                answer: (question, ctx) => this.answerVoice(question, ctx.device),
+                answer: (question, ctx) => this.answerVoice(question, ctx.device, { transport: 'udp', room: ctx.room, sttMs: ctx.sttMs }),
                 getHints: () => this.buildSttHints(),
                 log: this.log,
                 onStatus: (device, room, state) => {
@@ -586,11 +595,11 @@ class Assistant extends adapter_core_1.Adapter {
      * not re-trigger onStateChange). The state writes must not block the spoken reply, so they are
      * fire-and-forget.
      */
-    async answerVoice(question, source) {
+    async answerVoice(question, source, origin = {}) {
         this.setStateAsync('text.request', { val: question, ack: true }).catch(() => { });
         this.setQuerySource(source);
         this.log.info(`Voice Q (${source}): ${question}`);
-        const answer = await this.answer(question, source);
+        const answer = await this.answer(question, source, { satellite: source, ...origin });
         this.log.info(`Voice A (${source}): ${answer}`);
         this.setStateAsync('text.response', { val: answer, ack: true }).catch(() => { });
         return answer;
@@ -659,11 +668,17 @@ class Assistant extends adapter_core_1.Adapter {
                 pcm = pcm.subarray(44);
             }
             const language = msg.language || engines.language;
+            const sttStart = Date.now();
             const text = (await engines.stt.transcribe(pcm, rate, language, await this.buildSttHints())).trim();
             if (!text) {
                 return { text: '', answer: '' };
             }
-            const answer = await this.answerVoice(text, source);
+            const answer = await this.answerVoice(text, source, {
+                transport: 'native',
+                room,
+                wakeWord: typeof msg.wakeWord === 'string' ? msg.wakeWord : undefined,
+                sttMs: Date.now() - sttStart,
+            });
             if (!answer) {
                 return { text, answer: '' };
             }
@@ -2146,6 +2161,24 @@ class Assistant extends adapter_core_1.Adapter {
             }
             return;
         }
+        // Admin chat: the journal of the last hours (message = { since?: ms }), and wiping it.
+        if (obj.command === 'getJournal') {
+            const since = Number(obj.message?.since) || 0;
+            const result = this.journal?.enabled
+                ? { enabled: true, entries: this.journal.list(since) }
+                : { enabled: false, entries: [] };
+            if (obj.callback) {
+                this.sendTo(obj.from, obj.command, result, obj.callback);
+            }
+            return;
+        }
+        if (obj.command === 'clearJournal') {
+            this.journal?.clear();
+            if (obj.callback) {
+                this.sendTo(obj.from, obj.command, { ok: true }, obj.callback);
+            }
+            return;
+        }
         if (obj.command !== 'ask') {
             return;
         }
@@ -2168,13 +2201,14 @@ class Assistant extends adapter_core_1.Adapter {
             this.log.info(`A: ${answer}`);
             this.setStateAsync('text.response', { val: answer, ack: true }).catch(() => { });
             if (obj.callback) {
-                this.sendTo(obj.from, obj.command, { answer }, obj.callback);
+                // `journaled`: the admin chat gets this exchange from the journal and must not add it twice.
+                this.sendTo(obj.from, obj.command, { answer, journaled: !!this.journal?.enabled }, obj.callback);
             }
         }
         catch (e) {
             this.log.error(`Assistant error: ${e.message}`);
             if (obj.callback) {
-                this.sendTo(obj.from, obj.command, { error: e.message }, obj.callback);
+                this.sendTo(obj.from, obj.command, { error: e.message, journaled: !!this.journal?.enabled }, obj.callback);
             }
         }
     }
@@ -2187,7 +2221,12 @@ class Assistant extends adapter_core_1.Adapter {
      * is applied to the cloud LLM tier; every completed exchange (whichever tier answered) is recorded so
      * later turns have the full thread.
      */
-    async answer(question, source = '') {
+    answer(question, source = '', origin = {}) {
+        return this.journal
+            ? this.journal.run(question, source, origin, () => this.answerTracked(question, source))
+            : this.answerTracked(question, source);
+    }
+    async answerTracked(question, source) {
         const useCtx = this.config.useConversationContext !== false;
         const history = useCtx ? this.context.get(source) : [];
         const raw = await this.produceAnswer(question, history, source);
@@ -2195,6 +2234,9 @@ class Assistant extends adapter_core_1.Adapter {
         // (see followUpHint). Strip it here so it's neither stored, shown nor spoken, and expose it as the
         // follow-up flag. Single-user voice → a shared field is race-free enough (read right after await).
         this.lastFollowUp = /\[\[LISTEN\]\]/i.test(raw);
+        if (this.lastFollowUp) {
+            this.journal?.note({ followUp: true });
+        }
         const result = raw.replace(/\s*\[\[LISTEN\]\]\s*/gi, ' ').trim();
         if (useCtx && result) {
             this.context.add(source, question, result);
@@ -2278,6 +2320,7 @@ class Assistant extends adapter_core_1.Adapter {
         if (this.rings.length && (0, nlu_1.isStopCommand)(question)) {
             const n = this.stopRinging();
             this.log.info(`Ring stopped by voice (${n} session(s)).`);
+            this.journal?.note({ tier: 'stop' });
             const lang = String(this.config.voiceLanguage || this.language || 'en');
             return lang === 'ru' ? 'Хорошо.' : lang === 'de' ? 'Ok.' : 'Okay.';
         }
@@ -2288,6 +2331,7 @@ class Assistant extends adapter_core_1.Adapter {
             const asked = this.pending.question(source);
             if (this.pending.deliver(source, question)) {
                 this.log.info(`Answer to "${asked}" from source '${source || 'any'}': ${question}`);
+                this.journal?.note({ tier: 'askReply', detail: asked || undefined });
                 return '';
             }
         }
@@ -2297,6 +2341,7 @@ class Assistant extends adapter_core_1.Adapter {
         const routine = (0, routines_1.matchRoutine)(question, this.routines);
         if (routine) {
             this.log.info(`Routine '${routine.name}' triggered (source='${source}').`);
+            this.journal?.note({ tier: 'routine', detail: routine.name });
             await this.runRoutine(routine, source);
             return routine.reply;
         }
@@ -2330,6 +2375,7 @@ class Assistant extends adapter_core_1.Adapter {
                 const ans = await this.localLlm.ask(facts ? `${facts}\n\n${question}` : question);
                 if (ans && !(0, localLlm_1.isHandoff)(ans)) {
                     this.log.info(`Answered by local LLM (source='${source}').`);
+                    this.journal?.note({ tier: 'localLlm', detail: this.localLlmName() });
                     return ans;
                 }
                 this.log.debug('Local LLM handed off to the cloud LLM.');
@@ -2347,6 +2393,7 @@ class Assistant extends adapter_core_1.Adapter {
             // Provider "none": no tier further down. Say so instead of failing — over voice an error is
             // read out as a technical message.
             this.log.info(`No local tier could answer and no LLM provider is configured (source='${source}').`);
+            this.journal?.note({ tier: 'none' });
             return this.localOnlyFallback();
         }
         const ctx = await this.buildDeviceContext();
@@ -2359,6 +2406,10 @@ class Assistant extends adapter_core_1.Adapter {
         // Prepend the current date/time (and the weather line, if a source is configured) to the user turn —
         // cache-safe, see buildTimeContext. The stored history keeps the untouched question.
         const questionForLlm = [this.buildTimeContext(), weather, question].filter(Boolean).join('\n\n');
+        this.journal?.note({
+            tier: 'cloud',
+            detail: `${this.config.provider || 'openai'} · ${this.agent.model || 'auto'}`,
+        });
         return this.agent.ask(questionForLlm, sys, history);
     }
     /** Reply when nothing local understood the request and there is no cloud LLM (provider "none"). */
@@ -2431,6 +2482,81 @@ class Assistant extends adapter_core_1.Adapter {
         }
         api.registerUsedResource(type, data).catch(e => this.log.debug(`could not register ${type} ${port}: ${e.message}`));
     }
+    /**
+     * Open the conversation journal (shown in the admin chat). Every new or finished entry is mirrored to
+     * `journal.last` as JSON — the chat subscribes to it, which is what makes the view live.
+     */
+    async setupJournal() {
+        const hours = Math.max(0, Math.min(168, Number(this.config.journalHours ?? 24) || 0));
+        const file = path.join(this.instanceDataDir(), 'journal.json');
+        // Also in io-package `instanceObjects`; created here for instances that predate it.
+        await this.setObjectNotExistsAsync('journal', {
+            type: 'channel',
+            common: { name: 'Conversation journal' },
+            native: {},
+        });
+        await this.setObjectNotExistsAsync('journal.last', {
+            type: 'state',
+            common: {
+                name: 'Latest journal entry (JSON; written when a request starts and when it is answered)',
+                type: 'string',
+                role: 'json',
+                read: true,
+                write: false,
+                def: '',
+            },
+            native: {},
+        });
+        this.journal = new journal_1.Journal({
+            hours,
+            file,
+            log: this.log,
+            onChange: entry => {
+                this.setStateAsync('journal.last', { val: JSON.stringify(entry), ack: true }).catch(() => { });
+            },
+        });
+        if (hours) {
+            await this.journal.load();
+        }
+        else {
+            // Switched off: do not keep what was recorded while it was on.
+            await fs.promises.rm(file, { force: true }).catch(() => { });
+        }
+    }
+    /** Wrap the MCP connection so every state the pipeline reads or writes lands in the journal entry. */
+    journalMcp(mcp) {
+        return {
+            listTools: () => mcp.listTools(),
+            callTool: (name, args) => {
+                this.journal?.stateAccess(name, args);
+                return mcp.callTool(name, args);
+            },
+            close: () => mcp.close(),
+        };
+    }
+    /** Wrap an LLM tool so its calls (arguments, result, duration) land in the journal entry. */
+    journalTool(tool) {
+        return {
+            ...tool,
+            run: async (args) => {
+                const start = Date.now();
+                try {
+                    const result = await tool.run(args);
+                    this.journal?.tool(tool.name, args, Date.now() - start, result);
+                    return result;
+                }
+                catch (e) {
+                    this.journal?.tool(tool.name, args, Date.now() - start, undefined, e.message);
+                    throw e;
+                }
+            },
+        };
+    }
+    /** Short name of the local model for the journal ("qwen2.5-1.5b-instruct-q4_k_m"). */
+    localLlmName() {
+        const url = (this.config.localLlmModelUrl || '').trim() || localLlm_1.DEFAULT_LOCAL_MODEL_URL;
+        return (url.split(/[/\\]/).pop() || url).replace(/\?.*$/, '').replace(/\.gguf$/i, '');
+    }
     /** Writable per-instance data dir via the adapter-core function (with a fallback for old runtimes). */
     instanceDataDir() {
         try {
@@ -2559,6 +2685,7 @@ class Assistant extends adapter_core_1.Adapter {
         if (!intents.length || !intents.every(i => this.canExecuteNlu(i, devices.length))) {
             return null; // nothing matched, or one part cannot run here → let the LLM answer the whole thing
         }
+        this.journal?.note({ tier: 'nlu', detail: intents.map(i => i.action).join(' + ') });
         const answers = [];
         let failed = false;
         for (const intent of intents) {
@@ -4153,6 +4280,7 @@ class Assistant extends adapter_core_1.Adapter {
             }
             try {
                 await this.setForeignStateAsync(write.id, { val: write.value, ack: false });
+                this.journal?.stateAccess('set_state', { id: write.id, value: write.value });
                 this.log.info(`trigger '${def.id}': ${write.id} = ${JSON.stringify(write.value)}`);
             }
             catch (e) {
@@ -4888,6 +5016,12 @@ class Assistant extends adapter_core_1.Adapter {
         catch {
             // ignore
         }
+        try {
+            await this.journal?.flush();
+        }
+        catch {
+            // ignore
+        }
         try {
             await this.mcp?.close();
         }