halbot 1990.1.65 → 1990.1.67

package/README.md

@@ -103,10 +103,10 @@ All supported configuration fields:
     "help": "[[help information]]",
 
     // OPTIONAL, object.
-    // Session storage, support MariaDB/MySQL and Redis for now.
+    // Sessions/conversations storage, support MariaDB/MySQL and Redis for now.
     // If omitted, the bot will use memory storage and sync to this file.
     // Example: (Compatibility: https://github.com/sidorares/node-mysql2)
-    "session": {
+    "storage": {
         "type": "[["MARIADB" || "MYSQL"]]",
         "host": "[[DATABASE HOST]]",
         "database": "[[DATABASE NAME]]",
@@ -115,7 +115,7 @@ All supported configuration fields:
         ...[[OTHER DATABASE OPTIONS]],
     },
     // OR: (Compatibility: https://github.com/luin/ioredis)
-    "session": {
+    "storage": {
         "type": "REDIS",
         "host": "[[REDIS HOST]]",
         "password": "[[REDIS PASSWORD]]",
@@ -201,8 +201,10 @@ const config = {
     skillPath: [[pathToYourMiddlewares]],
 
     // OPTIONAL, object.
-    // Using customized callback as storage engine.
-    session: {
+    // Using customized storage engine.
+    // `storage` should Should be compatible with the `Map` interface:
+    // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map
+    storage: {
         get: async (key) => { /* return session object by chatId. */ },
         set: async (key, session) => { /* save session object by chatId. */ },
     },

package/bin/halbot.mjs

@@ -1,34 +1,34 @@
 #!/usr/bin/env node
 
-import { cache, dbio, memory, storage, utilitas } from 'utilitas';
+import { cache, dbio, memory, storage as _storage, utilitas } from 'utilitas';
 import halbot from '../index.mjs';
 
 const debug = utilitas.humanReadableBoolean(process.env['DEBUG']);
 const log = content => utilitas.log(content, import.meta.url);
-const getConfig = async () => (await storage.getConfig())?.config;
+const MEMORY = 'memory';
+const _getConfig = async () => await _storage.getConfig();
+const getConfig = async key => (await _getConfig())?.config?.[key];
 
-let session = {
-    get: async key => (await getConfig())?.sessions?.[key],
-    set: async (k, v) => await storage.setConfig({ sessions: { [k]: v } }),
+let storage = {
+    get: async key => (await getConfig(MEMORY))?.[key],
+    set: async (k, v) => await _storage.setConfig({ [MEMORY]: { [k]: v } }),
 };
 
 try {
-    const { filename, config } = await storage.getConfig();
+    const { filename, config } = await _getConfig();
     assert(utilitas.countKeys(config), `Error loading config from ${filename}.`);
-    const sessionType = utilitas.trim(config.session?.type, { case: 'UP' });
-    if (config.session?.type) { delete config.session.type; }
+    const sessionType = utilitas.trim(config.storage?.type, { case: 'UP' });
+    if (config.storage?.type) { delete config.storage.type; }
     switch (sessionType) {
         case 'MARIADB': case 'MYSQL':
-            await dbio.init(config.session);
-            await memory.init();
-            session = memory;
+            await dbio.init(config.storage);
+            storage = await memory.init();
             break;
         case 'REDIS':
-            await cache.init(config.session);
-            session = cache;
+            storage = await cache.init(config.storage);
             break;
         default:
-            config.session && utilitas.throwError('Invalid session config.');
+            config.storage && utilitas.throwError('Invalid storage config.');
     }
-    await halbot({ ...config, session });
+    await halbot({ ...config, storage });
 } catch (err) { debug ? utilitas.throwError(err) : log(err); }

package/index.mjs

@@ -31,6 +31,7 @@ const init = async (options) => {
     assert(options?.telegramToken, 'Telegram Bot API Token is required.');
     const [pkg, ai, _speech] = [await utilitas.which(), {}, {}];
     const info = bot.lines([`[${bot.EMOJI_BOT} ${pkg.title}](${pkg.homepage})`, pkg.description]);
+    const cacheOptions = options?.storage ? { store: options.storage } : null;
     if (options?.googleApiKey) {
         const apiKey = { apiKey: options?.googleApiKey };
         await Promise.all([
@@ -41,17 +42,19 @@ const init = async (options) => {
     if (options?.chatGptKey) {
         ai['ChatGPT'] = await hal.init({
             provider: 'CHATGPT', clientOptions: { apiKey: options.chatGptKey },
+            cacheOptions,
         });
     }
     if (options?.bingToken) {
         ai['Bing'] = await hal.init({
             provider: 'BING', clientOptions: { userToken: options.bingToken },
+            cacheOptions,
         });
     }
     assert(utilitas.countKeys(ai), 'No AI provider is configured.');
     const _bot = await bot.init({
-        ai, auth: options?.auth,
         args: options?.args,
+        auth: options?.auth,
         botToken: options?.telegramToken,
         chatType: options?.chatType,
         cmds: options?.cmds,
@@ -62,11 +65,12 @@ const init = async (options) => {
         magicWord: options?.magicWord,
         private: options?.private,
         provider: 'telegram',
-        session: options?.session,
+        session: options?.storage,
         skillPath: options?.skillPath || skillPath,
         speech: options?.googleApiKey && speech,
         vision: options?.googleApiKey && vision,
     });
+    _bot._.ai = ai;                                                             // Should be an array of a map of AIs.
     _bot._.lang = options?.lang || 'English';
     _bot._.prompts = await fetchPrompts();
     return _bot;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "halbot",
   "description": "Just another ChatGPT/Bing Chat Telegram bob, which is simple design, easy to use, extendable and fun.",
-  "version": "1990.1.65",
+  "version": "1990.1.67",
   "private": false,
   "homepage": "https://github.com/Leask/halbot",
   "type": "module",
@@ -29,17 +29,17 @@
     "url": "https://github.com/Leask/halbot.git"
   },
   "dependencies": {
-    "@google-cloud/speech": "^5.4.0",
-    "@google-cloud/text-to-speech": "^4.2.1",
-    "@google-cloud/vision": "^3.1.2",
+    "@google-cloud/speech": "^5.4.1",
+    "@google-cloud/text-to-speech": "^4.2.2",
+    "@google-cloud/vision": "^3.1.3",
     "@mozilla/readability": "^0.4.4",
-    "@waylaidwanderer/chatgpt-api": "^1.35.0",
+    "@waylaidwanderer/chatgpt-api": "github:Leask/node-chatgpt-api",
     "csv-parse": "^5.3.6",
     "ioredis": "^5.3.1",
     "jsdom": "^21.1.1",
-    "mysql2": "^3.2.0",
+    "mysql2": "^3.2.1",
     "telegraf": "^4.12.2",
-    "utilitas": "^1993.3.52",
+    "utilitas": "^1994.0.3",
     "youtube-transcript": "^1.0.5"
   }
 }

package/skills/{engine.mjs → 10_engine.mjs}

@@ -6,11 +6,15 @@ const bingTones = [balanced, 'creative', 'precise'];
 let configuredAi;
 
 const action = async (ctx, next) => {
+    ctx.session.context || (ctx.session.context = {});
+    ctx.session.latest || (ctx.session.latest = {});
     ctx.isDefaultAi = name => name === ctx.firstAi;
-    ctx.clear = () => (ctx.selectedAi || []).map(n => {
+    ctx.clear = context => (ctx.selectedAi || []).map(n => {
         ctx._.ai[n].clear(ctx.chatId);
-        ctx.hello();
-    });
+        delete ctx.session.context[n];
+        delete ctx.session.latest[n];
+        context && (ctx.session.context[n] = context);
+    }) && ctx.hello(context?.prompt);
     ctx.firstAi = (configuredAi = Object.keys(ctx._.ai))[0];
     switch (ctx.session.config?.ai) {
         case '': ctx.selectedAi = [ctx.firstAi]; break;
@@ -49,12 +53,21 @@ export const { run, priority, func, help, args } = {
         '¶ Tweak enhanced output rendering.',
         'Example 1: /set --render on',
         'Example 2: /set --render off',
+        // '¶ Select between [OpenAI models](https://platform.openai.com/docs/models).',
+        // "Tip !!!4!!!: Set `gptmodel=''` to use default OpenAI model.",
+        // 'Popular models:',
+        // '- [gpt-4](https://platform.openai.com/docs/models/gpt-4): 8192 tokens, trained Sep 2021 (Limited beta).',
+        // '- [gpt-4-32k](https://platform.openai.com/docs/models/gpt-4): 32768 tokens, trained Sep 2021 (Limited beta).',
+        // '- [gpt-3.5-turbo](https://platform.openai.com/docs/models/gpt-3-5): 4096 tokens, trained Sep 2021.',
+        // '- [text-davinci-003](https://platform.openai.com/docs/models/gpt-3-5): 4097 tokens, trained Sep 2021.',
+        // '- [text-davinci-002](https://platform.openai.com/docs/models/gpt-3-5): 4097 tokens, trained Sep 2021.',
+        // '- [code-davinci-002](https://platform.openai.com/docs/models/gpt-3-5): 8001 tokens, trained Sep 2021 (Coding Optimized).',
         '¶ Set tone-style for Bing.',
         "Tip 4: Set `tone=''` to use default tone-style.",
     ]),
     args: {
         hello: {
-            type: 'string', short: 'h', default: 'Hello!',
+            type: 'string', short: 's', default: 'You are ChatGPT, a large...',
             desc: "Change initial prompt: /set --hello 'Bonjour!'",
         },
         ai: {
@@ -67,6 +80,10 @@ export const { run, priority, func, help, args } = {
             desc: `\`(${bot.BINARY_STRINGS.join(', ')})\` Enable/Disable enhanced output rendering.`,
             validate: utilitas.humanReadableBoolean,
         },
+        // gptmodel: {
+        //     type: 'string', short: 'g', default: 'gpt-3.5-turbo',
+        //     desc: 'Set OpenAI model: /set --gptmodel=`MODEL`.',
+        // },
         tone: {
             type: 'string', short: 't', default: balanced,
             desc: `\`(${bingTones.join(', ')})\` Set tone-style for Bing.`,

package/skills/{wording.mjs → 40_wording.mjs}

@@ -26,15 +26,16 @@ const action = async (ctx, next) => {
             }
             const cnf = {
                 ...ctx.session.config = {
-                    ...ctx.session.config, ...ctx.config = {
+                    ...ctx.session.config,
+                    ...ctx.config = {
                         lang: ctx.cmd.args,
-                        hello: `Please reply in ${ctx.cmd.args}. Hello! `,
-                    }
+                        hello: `Please reply in ${ctx.cmd.args}. Hello!`,
+                    },
                 }
             };
-            Object.keys(ctx.config).map(x => cnf[x] = `${cnf[x]} <-- SET`);
-            ctx.action = bot.map(cnf);
-            await ctx.hello();
+            Object.keys(ctx.config).map(x => cnf[x] += ' <-- SET');
+            ctx.result = bot.map(cnf);
+            ctx.hello();
             break;
         case 'translate': promptTranslate(ctx, ctx.cmd.args || ctx.session.config?.lang || ctx._.lang); break;
         case 'polish': promptPolish(ctx); break;
@@ -48,7 +49,7 @@ const action = async (ctx, next) => {
 
 export const { run, priority, func, cmds, help } = {
     run: true,
-    priority: 50,
+    priority: 40,
     func: action,
     help: bot.lines([
         '¶ Set your default language.',

package/skills/50_execute.mjs

@@ -0,0 +1,16 @@
+
+const action = async (ctx, next) => {
+    const cmd = ctx.cmd?.cmd;
+    if (!ctx.context) {
+        const prompt = ctx.session.prompts?.[cmd] || ctx._.prompts?.[cmd]?.prompt;
+        prompt && (ctx.context = { cmd, prompt });
+    }
+    ctx.context && ctx.clear(ctx.context);
+    await next();
+};
+
+export const { run, priority, func } = {
+    run: true,
+    priority: 50,
+    func: action,
+};

package/skills/{prepare.mjs → 60_prepare.mjs}

@@ -5,16 +5,16 @@ const countTokens = text => text.split(/[^a-z0-9]/i).length;
 
 const action = async (ctx, next) => {
     // avatar
-    if (ctx.action) {
+    if (ctx.result) {
         ctx.avatar = '⚙️';
     } else if (ctx.msg?.voice) {
-        ctx.avatar = bot.EMOJI_SPEECH; ctx.action = utilitas.trim(ctx.text);
+        ctx.avatar = bot.EMOJI_SPEECH; ctx.result = utilitas.trim(ctx.text);
     } else if (ctx.msg?.data) {
-        ctx.avatar = '🔘'; ctx.action = utilitas.trim(ctx.text);
+        ctx.avatar = '🔘'; ctx.result = utilitas.trim(ctx.text);
     } else if (ctx.msg?.poll) {
         ctx.avatar = '📊';
     } else if (ctx.cmd?.cmd && ctx.cmd?.cmd !== 'clear') {
-        ctx.avatar = '🚀'; ctx.action = utilitas.trim(ctx.text);
+        ctx.avatar = '🚀'; ctx.result = utilitas.trim(ctx.text);
     } else {
         ctx.avatar = '😸';
     }
@@ -22,16 +22,15 @@ const action = async (ctx, next) => {
     const additionInfo = ctx.collected.length ? ctx.collected.map(
         x => x.content
     ).join('\n').split(' ') : [];
-    ctx.text = (ctx.text || '') + '\n\n';
-    while (countTokens(ctx.text) < 2250 && additionInfo.length) {
-        ctx.text += ` ${additionInfo.shift()}`;
+    ctx.prompt = (ctx.text || '') + '\n\n';
+    while (countTokens(ctx.prompt) < 2250 && additionInfo.length) {
+        ctx.prompt += ` ${additionInfo.shift()}`;
     }
-    ctx.text = utilitas.trim(ctx.text);
-    additionInfo.filter(x => x).length && (ctx.text += '...');
+    ctx.prompt = utilitas.trim(ctx.prompt);
+    additionInfo.filter(x => x).length && (ctx.prompt += '...');
     // next
     ctx.carry = {
-        session: ctx.chatId,
-        context: ctx.context,
+        sessionId: ctx.chatId,
         toneStyle: ctx.session.config?.tone,
     };
     await next();

package/skills/{chat.mjs → 70_chat.mjs}

@@ -7,22 +7,22 @@ const enrich = name => name === 'Bing' ? `${name} (Sydney)` : name;
 const log = content => utilitas.log(content, import.meta.url);
 
 const action = async (ctx, next) => {
-    if (!ctx.text) { return await next(); }
-    const [YOU, msgs, ctxs, tts, pms, extra]
-        = [`${ctx.avatar} You:`, {}, {}, {}, [], {}];
+    if (!ctx.prompt) { return await next(); }
+    const [YOU, msgs, tts, pms, extra] = [`${ctx.avatar} You:`, {}, {}, [], {}];
     let [lastMsg, lastSent] = [null, 0];
     const packMsg = options => {
-        const said = !options?.tts && ctx.action ? ctx.action : '';
+        const said = !options?.tts && ctx.result ? ctx.result : '';
         const packed = [...said ? [joinL2([YOU, said])] : []];
         const source = options?.tts ? tts : msgs;
         const pure = [];
         ctx.selectedAi.map(n => {
             const content = source[n] || '';
+            const cmd = ctx.session.context[n]?.cmd;
+            const context = cmd && ` > \`${cmd}\` (exit by /clear)` || '';
             pure.push(content);
             packed.push(joinL2([
-                ...ctx.multiAi || !ctx.isDefaultAi(n) || said || ctxs[n]?.cmd ? [
-                    `${BOT}${enrich(n)}${ctxs[n]?.cmd && ` > \`${ctxs[n].cmd}\` (exit by /clear)` || ''}:`
-                ] : [], content,
+                ...ctx.multiAi || !ctx.isDefaultAi(n) || said || context
+                    ? [`${BOT}${enrich(n)}${context}:`] : [], content,
             ]));
         });
         return options?.tts && !pure.join('').trim().length ? '' : joinL1(packed);
@@ -39,18 +39,19 @@ const action = async (ctx, next) => {
     for (let n of ctx.selectedAi) {
         pms.push((async () => {
             try {
-                const resp = await ctx._.ai[n].send(ctx.text, ctx.carry, token => {
+                const response = await ctx._.ai[n].send(ctx.prompt, {
+                    ...ctx.carry, session: ctx.session.latest[n], // promptPrefix: '',
+                }, token => {
                     msgs[n] = `${(msgs[n] || '')}${token}`;
                     ok(onProgress);
                 });
-                ctxs[n] = resp.context;
                 msgs[n] = ctx.session.config?.render === false
-                    ? resp.response : resp.responseRendered;
-                tts[n] = msgs[n].split('\n').some(x => /^```/.test(x)) ? '' : resp.spokenText;
-                extra.buttons = resp?.suggestedResponses?.map?.(label => ({
+                    ? response.response : response.responseRendered;
+                tts[n] = msgs[n].split('\n').some(x => /^```/.test(x)) ? '' : response.spokenText;
+                extra.buttons = response?.suggestedResponses?.map?.(label => ({
                     label, text: `/bing@${ctx.botInfo.username} ${label}`,
                 }));
-                return resp;
+                return ctx.session.latest[n] = response;
             } catch (err) {
                 msgs[n] = err?.message || err;
                 tts[n] = msgs[n];
@@ -58,11 +59,7 @@ const action = async (ctx, next) => {
             }
         })());
     }
-    ctx.session._latest = {
-        prompt: ctx.text,
-        carry: ctx.carry,
-        responses: await Promise.all(pms),
-    };
+    await Promise.all(pms);
     await ok();
     // ctx.responses = msgs; // save responses-to-user for next middleware
     ctx.tts = packMsg({ tts: true });

package/skills/execute.mjs

@@ -1,17 +0,0 @@
-
-const action = async (ctx, next) => {
-    const cmd = ctx.cmd?.cmd;
-    const prompt = ctx.session.prompts?.[cmd] || ctx._.prompts?.[cmd]?.prompt;
-    if (prompt) {
-        ctx.clear();
-        ctx.context = { cmd, prompt };
-        ctx.collect(prompt);
-    }
-    await next();
-};
-
-export const { run, priority, func } = {
-    run: true,
-    priority: 40,
-    func: action,
-};