@llblab/pi-telegram 0.2.8 → 0.2.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/AGENTS.md CHANGED
@@ -57,7 +57,8 @@
57
57
  - Keep comments and user-facing docs in English unless the surrounding file already follows another convention
58
58
  - Each project `.ts` file should start with a short multi-line responsibility header comment that explains the file boundary to future maintainers
59
59
  - Name extracted `/lib` modules and mirrored `/tests` suites by bare domain when the repository already supplies the Telegram scope; prefer `api.ts`, `queue.ts`, `updates.ts`, and `queue.test.ts` over redundant `telegram-*` filename prefixes
60
- - Prefer targeted edits, keeping `index.ts` as the orchestration layer and moving reusable logic into flat `/lib` domain modules when a subsystem becomes large enough to earn extraction; current extracted domains include queueing/runtime decisions, replies, polling, updates, attachments, registration and lifecycle-hook binding, Telegram API/config support, turn-building, media extraction, setup, rendering, status rendering, menu/model-resolution/UI support, and model-switch support
60
+ - Prefer targeted edits, keeping `index.ts` as the orchestration layer and moving reusable logic into flat `/lib` domain modules when a subsystem becomes large enough to earn extraction; current extracted domains include queueing/runtime decisions, preview streaming, replies, polling, updates, attachments, registration and lifecycle-hook binding, Telegram API/config support, turn-building, media extraction, setup, rendering, status rendering, menu/model-resolution/UI support, and model-switch support
61
+ - Keep preview appearance logic in the rendering domain and preview transport/lifecycle logic in the preview domain so richer streaming strategies can evolve without entangling Telegram delivery state with Markdown formatting rules
61
62
 
62
63
  ## 7. Operational Conventions
63
64
 
package/CHANGELOG.md CHANGED
@@ -2,6 +2,10 @@
2
2
 
3
3
  ## Current
4
4
 
5
+ - `[Rendering]` Hardened link rendering so absolute links stay clickable, markdown-heavy link labels reduce to plain clickable labels, tooltip titles are ignored safely, balanced-parenthesis URLs stay intact, and unsupported link forms degrade without broken anchors. Impact: Telegram replies now keep more links usable while avoiding malformed output for relative, reference-style, or footnote-like link syntax.
6
+ - `[Preview]` Evolved rich streaming from first-chunk snapshots to stable-block previews with a conservative plain tail fallback, while preserving original blank-line spacing between rendered blocks and keeping headings visually separated from following blocks. Impact: closed top-level Markdown blocks now stream as rich Telegram HTML before finalization, incomplete fences, quotes, lists, and other trailing work remain readable without producing broken rich formatting, preview/final block spacing no longer collapses extra empty lines, and headings no longer visually merge into following code blocks when source Markdown omits a blank line.
7
+ - `[Refactor]` Split preview concerns so runtime transport and finalization live in the preview domain while preview snapshot derivation lives in the rendering domain. Impact: rich streaming can evolve independently from final reply delivery while keeping preview appearance decisions closer to the Telegram renderer.
8
+ - `[Streaming]` Switched Telegram previews from plain draft-first text to rich first-chunk message editing, so formatting appears during generation instead of only after finalization. Impact: users now see richer streamed output earlier, while final replies still replace the preview with fully rendered Telegram HTML.
5
9
  - `[Rendering]` Preserved leading indentation on the first Markdown line, kept numeric markers for ordered task lists in both preview and final Telegram rendering, and stopped reinterpreting standalone `[x]` or `[ ]` prose as inline checkboxes. Impact: nested content no longer flattens when a message starts with indentation, numbered checklists keep their ordered semantics, and literal checklist-like prose stays literal.
6
10
  - `[Queue UI]` Marked liked high-priority queued Telegram turns with `⬆` in the pi status-bar queue preview. Impact: operators can now distinguish reaction-promoted turns from normal queued prompts at a glance.
7
11
  - `[Docs]` Added short responsibility header comments to every project `.ts` file. Impact: file boundaries are easier to understand while navigating the growing `/lib` split.
package/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  ![pi-telegram screenshot](screenshot.png)
4
4
 
5
- Telegram DM bridge for pi.
5
+ Better Telegram DM bridge for pi.
6
6
 
7
7
  This repository is an actively maintained fork of [`badlogic/pi-telegram`](https://github.com/badlogic/pi-telegram). It started from upstream commit [`cb34008460b6c1ca036d92322f69d87f626be0fc`](https://github.com/badlogic/pi-telegram/commit/cb34008460b6c1ca036d92322f69d87f626be0fc) and has since diverged substantially.
8
8
 
@@ -19,9 +19,9 @@ This repository is an actively maintained fork of [`badlogic/pi-telegram`](https
19
19
  - **Interactive UI**: Manage your session directly from Telegram. Inline buttons allow you to switch models and adjust reasoning (thinking) levels on the fly.
20
20
  - **In-flight Model Switching**: Change the active model mid-generation. The agent gracefully pauses, applies the new model, and restarts its response without losing context.
21
21
  - **Smart Message Queue**: Messages sent while the agent is busy are queued and previewed in the pi status bar, and queued turns can be reprioritized or removed with Telegram reactions.
22
- - **Mobile-Optimized Rendering**: Tables and lists are formatted for narrow screens. Markdown is correctly parsed and split to fit Telegram's limits without breaking HTML structures or code blocks.
22
+ - **Mobile-Optimized Rendering**: Tables and lists are formatted for narrow screens. Markdown is correctly parsed and split to fit Telegram's limits without breaking HTML structures or code blocks, block spacing stays faithful to the original Markdown with readable heading separation, supported absolute links stay clickable, and unsupported link forms degrade safely.
23
23
  - **File Handling & Attachments**: Send images and files to the agent, or ask it to generate and return artifacts. Outbound files are delivered automatically via the `telegram_attach` tool.
24
- - **Streaming Responses**: Smooth, real-time typing effect using Telegram Drafts (or message edits as a fallback).
24
+ - **Streaming Responses**: Closed Markdown blocks stream back as rich Telegram HTML while pi is generating, and the still-growing tail stays readable until the final fully rendered reply lands.
25
25
 
26
26
  ## Install
27
27
 
@@ -80,7 +80,7 @@ Once paired, simply chat with your bot in Telegram. All text, images, and files
80
80
  - **`/status`**: View session stats, cost, and use inline buttons to change models.
81
81
  - **`/model`**: Open the interactive model selector.
82
82
  - **`/compact`**: Start session compaction (only works when the session is idle).
83
- - **`/stop`** (or just **`stop`**): Abort the active run.
83
+ - **`/stop`**: Abort the active run.
84
84
  - **`/telegram-disconnect`** (in pi): Stop polling in the current session.
85
85
  - **`/telegram-status`** (in pi): Check bridge status.
86
86
 
@@ -104,9 +104,9 @@ Examples:
104
104
 
105
105
  ## Streaming
106
106
 
107
- The extension streams assistant text previews back to Telegram while pi is generating.
107
+ The extension streams assistant previews back to Telegram while pi is generating.
108
108
 
109
- It tries Telegram draft streaming first with `sendMessageDraft`. If that is not supported for your bot, it falls back to `sendMessage` plus `editMessageText`.
109
+ Rich previews are sent through editable messages because Telegram drafts are text-only. Closed top-level Markdown blocks can appear with formatting before the answer finishes, while the still-growing tail remains conservative and readable until the preview is replaced with the fully rendered Telegram HTML reply.
110
110
 
111
111
  ## Notes
112
112
 
@@ -21,7 +21,9 @@ Current runtime areas include:
21
21
 
22
22
  - Telegram API types and local bridge state in `index.ts`
23
23
  - Queueing and queue-runtime helpers in `/lib/queue.ts`
24
- - Reply, preview, preview-finalization, reply-transport, and rendered-message delivery helpers in `/lib/replies.ts`
24
+ - Preview transport-selection, preview-finalization, and preview-runtime helpers in `/lib/preview.ts`
25
+ - Reply-transport and rendered-message delivery helpers in `/lib/replies.ts`
26
+ - Preview appearance and snapshot derivation stay in `/lib/rendering.ts`, while `/lib/preview.ts` owns transport and lifecycle decisions, so richer preview strategies can evolve without entangling Markdown formatting with Telegram delivery state
25
27
  - Polling request, stop-condition, and long-poll loop helpers in `/lib/polling.ts`
26
28
  - Telegram API/config helpers and lazy bot-token client wrappers in `/lib/api.ts`
27
29
  - Telegram turn-building helpers in `/lib/turns.ts`
@@ -30,7 +32,7 @@ Current runtime areas include:
30
32
  - Telegram attachment queueing and delivery helpers in `/lib/attachments.ts`
31
33
  - Telegram tool, command, and lifecycle-hook registration helpers in `/lib/registration.ts`
32
34
  - Setup/token prompt helpers in `/lib/setup.ts`
33
- - Markdown and Telegram message rendering helpers in `/lib/rendering.ts`
35
+ - Markdown, preview-snapshot, and Telegram message rendering helpers in `/lib/rendering.ts`
34
36
  - Status rendering helpers in `/lib/status.ts`
35
37
  - Menu/model-resolution, menu-state construction, pure menu-page derivation, pure menu render-payload builders, menu-message runtime, callback parsing, callback entry handling, callback mutation helpers, full model-callback planning and execution, interface-polished callback effect ports, status-thinking callback handling, and UI helpers in `/lib/menu.ts`
36
38
  - Model-switch guard, continuation, and restart helpers in `/lib/model-switch.ts`
@@ -94,13 +96,15 @@ Key rules:
94
96
 
95
97
  - Rich text should render cleanly in Telegram chats
96
98
  - Real code blocks must remain literal and escaped
99
+ - Supported absolute HTTP(S) and mailto links should stay clickable, while unsupported link forms such as unresolved references, footnotes, or relative links without a known base should degrade safely instead of producing broken Telegram anchors
97
100
  - Markdown tables should keep their internal separators but drop the outer left and right borders when rendered as monospace blocks so narrow Telegram clients keep more usable width
98
101
  - Unordered Markdown lists should render with a monospace `-` marker and ordered Markdown lists should render with monospace numeric markers so list indentation stays more predictable on narrow Telegram clients
99
102
  - Real Markdown task-list items should render with checkbox markers, while standalone `[x]` and `[ ]` prose should stay literal instead of being reinterpreted as checklists
100
103
  - Nested Markdown quotes should flatten into one Telegram blockquote with added non-breaking-space indentation because Telegram does not render nested blockquotes reliably
104
+ - Original blank-line spacing between Markdown blocks should stay intact in both preview and final rendering instead of being collapsed to one generic block separator, while headings should still keep readable separation from following blocks such as code fences even when source Markdown omits a blank line
101
105
  - Long replies must be split below Telegram's 4096-character limit
102
106
  - Chunking should avoid breaking HTML structure where possible
103
- - Preview rendering is intentionally simpler than final rich rendering
107
+ - Preview rendering uses stable top-level Markdown blocks for rich Telegram HTML and appends the still-growing tail conservatively as readable plain text so the preview stays valid even when the answer is incomplete
104
108
 
105
109
  The renderer is a Telegram-specific formatter, not a general Markdown engine, so rendering changes should be treated as regression-prone.
106
110
 
@@ -110,10 +114,12 @@ During generation, the bridge streams previews back to Telegram.
110
114
 
111
115
  Preferred order:
112
116
 
113
- 1. Try `sendMessageDraft`
114
- 2. Fall back to `sendMessage` plus `editMessageText`
117
+ 1. Re-render the current Markdown buffer into a preview snapshot that renders closed top-level blocks as rich Telegram HTML and keeps the unstable tail conservative and readable
118
+ 2. Send or update that preview through `sendMessage` plus `editMessageText`, because `sendMessageDraft` is text-only for rich previews
115
119
  3. Replace the preview with the final rendered reply when generation ends
116
120
 
121
+ Draft streaming can remain as a plain-text fallback path, but rich Telegram previews are driven through editable messages and stable-block snapshot selection.
122
+
117
123
  Outbound files are sent only after the active Telegram turn completes and must be staged through the `telegram_attach` tool.
118
124
 
119
125
  ## Interactive Controls
package/index.ts CHANGED
@@ -87,11 +87,14 @@ import {
87
87
  type TelegramRenderMode,
88
88
  } from "./lib/rendering.ts";
89
89
  import {
90
- buildTelegramReplyTransport,
91
90
  clearTelegramPreview,
92
91
  finalizeTelegramMarkdownPreview,
93
92
  finalizeTelegramPreview,
94
93
  flushTelegramPreview,
94
+ type TelegramPreviewRuntimeState,
95
+ } from "./lib/preview.ts";
96
+ import {
97
+ buildTelegramReplyTransport,
95
98
  sendTelegramMarkdownReply,
96
99
  sendTelegramPlainReply,
97
100
  } from "./lib/replies.ts";
@@ -267,14 +270,7 @@ interface DownloadedTelegramFile {
267
270
 
268
271
  type ActiveTelegramTurn = PendingTelegramTurn;
269
272
 
270
- interface TelegramPreviewState {
271
- mode: "draft" | "message";
272
- draftId?: number;
273
- messageId?: number;
274
- pendingText: string;
275
- lastSentText: string;
276
- flushTimer?: ReturnType<typeof setTimeout>;
277
- }
273
+ type TelegramPreviewState = TelegramPreviewRuntimeState;
278
274
 
279
275
  interface TelegramMediaGroupState {
280
276
  messages: TelegramMessage[];
@@ -691,21 +687,28 @@ export default function (pi: ExtensionAPI) {
691
687
  text,
692
688
  });
693
689
  },
694
- sendMessage: async (chatId: number, text: string) => {
690
+ sendMessage: async (
691
+ chatId: number,
692
+ text: string,
693
+ options?: { parseMode?: "HTML" },
694
+ ) => {
695
695
  return callTelegramApi<TelegramSentMessage>("sendMessage", {
696
696
  chat_id: chatId,
697
697
  text,
698
+ parse_mode: options?.parseMode,
698
699
  });
699
700
  },
700
701
  editMessageText: async (
701
702
  chatId: number,
702
703
  messageId: number,
703
704
  text: string,
705
+ options?: { parseMode?: "HTML" },
704
706
  ) => {
705
707
  await editTelegramMessageText({
706
708
  chat_id: chatId,
707
709
  message_id: messageId,
708
710
  text,
711
+ parse_mode: options?.parseMode,
709
712
  });
710
713
  },
711
714
  renderTelegramMessage,
package/lib/preview.ts ADDED
@@ -0,0 +1,212 @@
1
+ /**
2
+ * Telegram preview streaming helpers
3
+ * Owns preview transport selection, runtime updates, and preview finalization
4
+ */
5
+
6
+ import {
7
+ buildTelegramPreviewSnapshot,
8
+ type TelegramPreviewRenderStrategy,
9
+ type TelegramPreviewSnapshot,
10
+ type TelegramRenderedChunk,
11
+ type TelegramRenderMode,
12
+ } from "./rendering.ts";
13
+
14
+ export interface TelegramPreviewStateLike {
15
+ mode: "draft" | "message";
16
+ draftId?: number;
17
+ messageId?: number;
18
+ pendingText: string;
19
+ lastSentText: string;
20
+ lastSentParseMode?: "HTML";
21
+ lastSentStrategy?: TelegramPreviewRenderStrategy;
22
+ }
23
+
24
+ export interface TelegramPreviewRuntimeState extends TelegramPreviewStateLike {
25
+ flushTimer?: ReturnType<typeof setTimeout>;
26
+ }
27
+
28
+ export interface TelegramSentPreviewMessageLike {
29
+ message_id: number;
30
+ }
31
+
32
+ export interface TelegramPreviewRuntimeDeps {
33
+ getState: () => TelegramPreviewRuntimeState | undefined;
34
+ setState: (state: TelegramPreviewRuntimeState | undefined) => void;
35
+ clearScheduledFlush: (state: TelegramPreviewRuntimeState) => void;
36
+ maxMessageLength: number;
37
+ renderPreviewText: (markdown: string) => string;
38
+ getDraftSupport: () => "unknown" | "supported" | "unsupported";
39
+ setDraftSupport: (support: "unknown" | "supported" | "unsupported") => void;
40
+ allocateDraftId: () => number;
41
+ sendDraft: (chatId: number, draftId: number, text: string) => Promise<void>;
42
+ sendMessage: (
43
+ chatId: number,
44
+ text: string,
45
+ options?: { parseMode?: "HTML" },
46
+ ) => Promise<TelegramSentPreviewMessageLike>;
47
+ editMessageText: (
48
+ chatId: number,
49
+ messageId: number,
50
+ text: string,
51
+ options?: { parseMode?: "HTML" },
52
+ ) => Promise<void>;
53
+ renderTelegramMessage: (
54
+ text: string,
55
+ options?: { mode?: TelegramRenderMode },
56
+ ) => TelegramRenderedChunk[];
57
+ sendRenderedChunks: (
58
+ chatId: number,
59
+ chunks: TelegramRenderedChunk[],
60
+ ) => Promise<number | undefined>;
61
+ editRenderedMessage: (
62
+ chatId: number,
63
+ messageId: number,
64
+ chunks: TelegramRenderedChunk[],
65
+ ) => Promise<number | undefined>;
66
+ }
67
+
68
+ export function buildTelegramPreviewFinalText(
69
+ state: TelegramPreviewStateLike,
70
+ ): string | undefined {
71
+ const finalText = state.pendingText.trim();
72
+ if (finalText) return finalText;
73
+ if (
74
+ state.lastSentStrategy === "rich-stable-blocks" ||
75
+ state.lastSentParseMode === "HTML"
76
+ ) {
77
+ return undefined;
78
+ }
79
+ return state.lastSentText.trim() || undefined;
80
+ }
81
+
82
+ export function shouldUseTelegramDraftPreview(options: {
83
+ draftSupport: "unknown" | "supported" | "unsupported";
84
+ snapshot?: TelegramPreviewSnapshot;
85
+ }): boolean {
86
+ return (
87
+ options.draftSupport !== "unsupported" &&
88
+ (options.snapshot === undefined || options.snapshot.strategy === "plain")
89
+ );
90
+ }
91
+
92
+ export async function clearTelegramPreview(
93
+ chatId: number,
94
+ deps: TelegramPreviewRuntimeDeps,
95
+ ): Promise<void> {
96
+ const state = deps.getState();
97
+ if (!state) return;
98
+ deps.clearScheduledFlush(state);
99
+ deps.setState(undefined);
100
+ if (state.mode !== "draft" || state.draftId === undefined) return;
101
+ try {
102
+ await deps.sendDraft(chatId, state.draftId, "");
103
+ } catch {
104
+ // ignore
105
+ }
106
+ }
107
+
108
+ export async function flushTelegramPreview(
109
+ chatId: number,
110
+ deps: TelegramPreviewRuntimeDeps,
111
+ ): Promise<void> {
112
+ const state = deps.getState();
113
+ if (!state) return;
114
+ state.flushTimer = undefined;
115
+ const snapshot = buildTelegramPreviewSnapshot({
116
+ state,
117
+ maxMessageLength: deps.maxMessageLength,
118
+ renderPreviewText: deps.renderPreviewText,
119
+ renderTelegramMessage: deps.renderTelegramMessage,
120
+ });
121
+ if (!snapshot) return;
122
+ if (
123
+ shouldUseTelegramDraftPreview({
124
+ draftSupport: deps.getDraftSupport(),
125
+ snapshot,
126
+ })
127
+ ) {
128
+ const draftId = state.draftId ?? deps.allocateDraftId();
129
+ state.draftId = draftId;
130
+ try {
131
+ await deps.sendDraft(chatId, draftId, snapshot.text);
132
+ deps.setDraftSupport("supported");
133
+ state.mode = "draft";
134
+ state.lastSentText = snapshot.text;
135
+ state.lastSentParseMode = snapshot.parseMode;
136
+ state.lastSentStrategy = snapshot.strategy;
137
+ return;
138
+ } catch {
139
+ deps.setDraftSupport("unsupported");
140
+ }
141
+ }
142
+ if (state.mode === "draft" && state.draftId !== undefined) {
143
+ try {
144
+ await deps.sendDraft(chatId, state.draftId, "");
145
+ } catch {
146
+ // ignore
147
+ }
148
+ }
149
+ if (state.messageId === undefined) {
150
+ const sent = await deps.sendMessage(chatId, snapshot.text, {
151
+ parseMode: snapshot.parseMode,
152
+ });
153
+ state.messageId = sent.message_id;
154
+ state.mode = "message";
155
+ state.lastSentText = snapshot.text;
156
+ state.lastSentParseMode = snapshot.parseMode;
157
+ state.lastSentStrategy = snapshot.strategy;
158
+ return;
159
+ }
160
+ await deps.editMessageText(chatId, state.messageId, snapshot.text, {
161
+ parseMode: snapshot.parseMode,
162
+ });
163
+ state.mode = "message";
164
+ state.lastSentText = snapshot.text;
165
+ state.lastSentParseMode = snapshot.parseMode;
166
+ state.lastSentStrategy = snapshot.strategy;
167
+ }
168
+
169
+ export async function finalizeTelegramPreview(
170
+ chatId: number,
171
+ deps: TelegramPreviewRuntimeDeps,
172
+ ): Promise<boolean> {
173
+ const state = deps.getState();
174
+ if (!state) return false;
175
+ await flushTelegramPreview(chatId, deps);
176
+ const finalText = buildTelegramPreviewFinalText(state);
177
+ if (!finalText) {
178
+ await clearTelegramPreview(chatId, deps);
179
+ return false;
180
+ }
181
+ if (state.mode === "draft") {
182
+ await deps.sendMessage(chatId, finalText);
183
+ await clearTelegramPreview(chatId, deps);
184
+ return true;
185
+ }
186
+ deps.setState(undefined);
187
+ return state.messageId !== undefined;
188
+ }
189
+
190
+ export async function finalizeTelegramMarkdownPreview(
191
+ chatId: number,
192
+ markdown: string,
193
+ deps: TelegramPreviewRuntimeDeps,
194
+ ): Promise<boolean> {
195
+ const state = deps.getState();
196
+ if (!state) return false;
197
+ await flushTelegramPreview(chatId, deps);
198
+ const chunks = deps.renderTelegramMessage(markdown, { mode: "markdown" });
199
+ if (chunks.length === 0) {
200
+ await clearTelegramPreview(chatId, deps);
201
+ return false;
202
+ }
203
+ if (state.mode === "draft") {
204
+ await deps.sendRenderedChunks(chatId, chunks);
205
+ await clearTelegramPreview(chatId, deps);
206
+ return true;
207
+ }
208
+ if (state.messageId === undefined) return false;
209
+ await deps.editRenderedMessage(chatId, state.messageId, chunks);
210
+ deps.setState(undefined);
211
+ return true;
212
+ }