@rhizogrip/spore-plugin-telegram 0.5.0 → 0.6.1

package/README.md

@@ -67,7 +67,7 @@ says so in your `working…` message, and the next turn answers it.
 
 ```
 /status    what the spore is doing, its turns and what they cost, and the running turn's limits
-/stop      end the turn it is running
+/stop      end the turn it is running, and set aside what you sent that it had not read
 /wrap [10m]        ask the running turn to wrap up, now or in a while
 /extend wall 30m   give it more — wall, cost or rounds — up to the extend.<limit> its spore.cmk grants
 ```
@@ -104,13 +104,25 @@ timed, a command that exited non-zero given its exit code, a call that failed ma
 machine, and a command line or a path is yours. A chat can ask for the calls themselves:
 
 ```json
-{ "token": "${MAIN_BOT_TOKEN}", "chats": { "51168024": { "spore": "main", "details": true } } }
+{ "token": "${TRIAGE_BOT_TOKEN}", "chats": { "148392011": { "spore": "triage", "details": true } } }
 ```
 
 It is then shown `reading data/report.md`, `running git log --oneline -5`,
 `source forgejo --path …` — the first line, cut short. Choose it for a chat you would let
 read the commands; the others keep the kinds.
 
+A chat can be shown a turn more quietly, which is what a group gets unless its entry says
+otherwise: `"show": "react"` puts a 👨‍💻 on your message when the spore takes it and shows Telegram's
+`typing…` while the turn runs, then takes the 👨‍💻 off when the answer arrives — or puts a 💔 there
+when the turn ended without one. `"show": "working"` is the `working…` message, what a private
+chat gets; `"show": "both"` is both. The bot's two emoji are its own to choose, from the ones
+Telegram lets a bot react with (✅ and ❌ are not among them; the log lists them when one is refused):
+
+```json
+{ "token": "${OPS_BOT_TOKEN}", "react": { "taken": "👀", "failed": "🤷" },
+  "chats": { "-1001234567": { "spore": "triage", "show": "react" } } }
+```
+
 Two chats may point at one spore and then share its conversation. A reply goes to the
 chat that asked; a turn nobody in a chat started goes to the spore's default.
 
@@ -121,7 +133,9 @@ refused chat 148392011 (@alice) — to allow it, add "148392011": "<a spore>" to
 ```
 
 which is also how you learn your own chat id: start with `"chats": {}` and message the bot. A
-group's id is negative, and it is the group you add rather than the people in it.
+group's id is negative, and it is the group you add rather than the people in it. Where a spore's
+`replyTo` default is one of this bot's chats, that chat is told the same line, once per chat the
+file does not name, so you hear of someone trying the bot without reading its log.
 
 ## What it keeps
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rhizogrip/spore-plugin-telegram",
-  "version": "0.5.0",
+  "version": "0.6.1",
   "description": "Telegram for spores: a bot of yours in chats, each chat reaching its spore, run as a service",
   "author": {
     "name": "Christophe Le Bars",
@@ -31,13 +31,13 @@
     "marked": "^18.0.11"
   },
   "peerDependencies": {
-    "@rhizogrip/spore": "^1.16.0"
+    "@rhizogrip/spore": "^1.19.0"
   },
   "scripts": {
     "test": "vitest run"
   },
   "spore": {
-    "works": "^1.16.0",
+    "works": "^1.19.0",
     "services": {
       "telegram": {
         "what": "a bot of yours in Telegram chats, each chat reaching its spore",

package/src/adapter.js

@@ -13,14 +13,30 @@ const NOT_MODIFIED = /message is not modified/
 const CANNOT_PARSE = /can't parse entities/i
 const SHAPE = '{ "token": "${TRIAGE_BOT_TOKEN}", "chats": { "<chat id>": "<spore>" } }' // eslint-disable-line no-template-curly-in-string
 
+/** What a bot may react with: `ReactionTypeEmoji` in the Bot API. */
+const REACTIONS = [
+  '❤', '👍', '👎', '🔥', '🥰', '👏', '😁', '🤔', '🤯', '😱',
+  '🤬', '😢', '🎉', '🤩', '🤮', '💩', '🙏', '👌', '🕊', '🤡',
+  '🥱', '🥴', '😍', '🐳', '❤‍🔥', '🌚', '🌭', '💯', '🤣', '⚡',
+  '🍌', '🏆', '💔', '🤨', '😐', '🍓', '🍾', '💋', '🖕', '😈',
+  '😴', '😭', '🤓', '👻', '👨‍💻', '👀', '🎃', '🙈', '😇', '😨',
+  '🤝', '✍', '🤗', '🫡', '🎅', '🎄', '☃', '💅', '🤪', '🗿',
+  '🆒', '💘', '🙉', '🦄', '😘', '💊', '🙊', '😎', '👾', '🤷‍♂',
+  '🤷', '🤷‍♀', '😡'
+]
+
+const FIELDS = ['token', 'chats', 'react']
+const CHAT_FIELDS = ['spore', 'details', 'show']
+
 const said = (err) => [err.message, err.detail].filter(Boolean).join(' — ')
 
 const invalid = (path, problem, detail) => new SporeError(`${path} ${problem}`, { type: 'TELEGRAM_BOT_INVALID', detail })
 
 /**
- * `{ "<chat id>": "<spore>" }`, or `{ "<chat id>": { "spore": "<spore>", "details": true } }` for a
- * chat shown what each call does — its command or path — rather than only what kind of call it
- * is: a Telegram message leaves the machine, so that is a choice made per chat.
+ * `{ "<chat id>": "<spore>" }`, or `{ "<chat id>": { "spore": "<spore>", "details": true, "show":
+ * "react" } }`: `details` for a chat shown what each call does — its command or path — rather than
+ * only what kind of call it is, since a Telegram message leaves the machine; `show` for how a turn
+ * shows itself there.
  */
 function routes (raw, path) {
   if (typeof raw.chats !== 'object' || raw.chats === null || Array.isArray(raw.chats)) {
@@ -29,22 +45,26 @@ function routes (raw, path) {
   const table = new Map()
   for (const [chat, entry] of Object.entries(raw.chats)) {
     const spore = typeof entry === 'string' ? entry : entry?.spore
-    const extra = typeof entry === 'object' && entry !== null ? Object.keys(entry).filter(key => !['spore', 'details'].includes(key)) : []
-    if (typeof spore !== 'string' || !spore || extra.length || (typeof entry === 'object' && entry.details !== undefined && typeof entry.details !== 'boolean')) {
-      throw invalid(path, `maps ${chat} to something that is not a spore`, 'each chat is a chat id against the name of a spore it may reach, or { "spore": "<name>", "details": true }')
+    const extra = typeof entry === 'object' && entry !== null ? Object.keys(entry).filter(key => !CHAT_FIELDS.includes(key)) : []
+    if (extra.length) {
+      const bots = extra.filter(key => FIELDS.includes(key))
+      throw invalid(path, `gives chat ${chat} ${extra.join(', ')}, which a chat does not take`, `a chat takes ${CHAT_FIELDS.join(', ')}${bots.length ? `; ${bots.join(', ')} is the bot's, beside chats` : ''}`)
+    }
+    if (typeof spore !== 'string' || !spore || (typeof entry === 'object' && entry.details !== undefined && typeof entry.details !== 'boolean')) {
+      throw invalid(path, `maps ${chat} to something that is not a spore`, 'each chat is a chat id against the name of a spore it may reach, or { "spore": "<name>", "details": true, "show": "react" }')
     }
-    table.set(chat, { spores: [spore], details: typeof entry === 'object' && entry.details === true })
+    table.set(chat, { spores: [spore], details: typeof entry === 'object' && entry.details === true, show: typeof entry === 'object' ? entry.show ?? null : null })
   }
   return table
 }
 
-const HELP = 'Anything you write here goes to the spore. /status says what it is doing; /stop ends the turn it is running; /wrap [10m] asks it to wrap up; /extend wall 30m gives it more, as far as its spore.cmk allows.'
+const HELP = 'Anything you write here goes to the spore. /status says what it is doing; /stop ends the turn it is running and sets aside what you sent that it had not read; /wrap [10m] asks it to wrap up; /extend wall 30m gives it more, as far as its spore.cmk allows.'
 
 export const TELEGRAM = {
   kind: 'telegram',
   label: 'Telegram',
   noun: 'chat',
-  fields: ['token', 'chats'],
+  fields: FIELDS,
   credentials: ['token'],
   stateFields: [],
   sourceVariables: [],
@@ -52,8 +72,9 @@ export const TELEGRAM = {
   example: SHAPE,
   routes,
   usage: { help: HELP, extend: '/extend wall 30m, /extend cost 1.50 or /extend rounds 20' },
-  limits: { message: 4096, file: 50 * 1024 * 1024, editEveryMs: 2500 },
-  can: { upload: true, remove: true },
+  limits: { message: 4096, file: 50 * 1024 * 1024, editEveryMs: 2500, typingEveryMs: 4000 },
+  can: { upload: true, remove: true, react: true, typing: true },
+  reactions: REACTIONS,
   hint (err, { file, bot }) {
     if (err.type === 'TELEGRAM_NO_BOT') {
       const variable = `${bot.toUpperCase().replace(/[^A-Z0-9]/g, '_')}_BOT_TOKEN`
@@ -81,6 +102,7 @@ export function normalize (update, bot) {
     message: message.message_id,
     person: { id: String(message.from.id), name: `${[first, last].filter(Boolean).join(' ')}${username ? ` (@${username})` : ''}`, username },
     where: message.chat.type === 'private' ? 'a private chat on Telegram' : `the Telegram group "${message.chat.title}"`,
+    shared: message.chat.type !== 'private',
     text,
     command: command ? { verb: command[1].toLowerCase(), args: command[3] ?? '' } : null,
     addresses: null,
@@ -146,6 +168,10 @@ export function createAdapter ({ telegram, bot }) {
 
     remove: (conversation, note) => telegram.remove(Number(conversation), note),
 
-    upload: (conversation, file, caption) => telegram.document(Number(conversation), file, caption)
+    upload: (conversation, file, caption) => telegram.document(Number(conversation), file, caption),
+
+    react: (conversation, message, emoji) => telegram.react(Number(conversation), message, emoji),
+
+    typing: (conversation) => telegram.typing(Number(conversation))
   }
 }

package/src/api.js

@@ -64,6 +64,12 @@ export function createTelegram (token, { fetchImpl = fetch, base = BASE } = {})
 
     remove: (chat, message) => call('deleteMessage', { chat_id: chat, message_id: message }),
 
+    /** `emoji` on the message as the bot's one reaction, or none when it is null. */
+    react: (chat, message, emoji) =>
+      call('setMessageReaction', { chat_id: chat, message_id: message, reaction: emoji === null ? [] : [{ type: 'emoji', emoji }] }),
+
+    typing: (chat) => call('sendChatAction', { chat_id: chat, action: 'typing' }),
+
     document: (chat, { path, mime }, caption) => {
       const form = new FormData()
       form.append('chat_id', String(chat))