Initial commit

Author: KnorpelSenf

.github/workflows/deno.yml

@@ -0,0 +1,65 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+# This workflow will install Deno and run tests across stable and nightly builds on Windows, Ubuntu and macOS.
+# For more information see: https://github.com/denolib/setup-deno
+
+name: grammY stream
+
+on:
+    push:
+        branches: [main]
+    pull_request:
+        branches: [main]
+
+jobs:
+    backport:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Setup repo
+              uses: actions/checkout@v4
+
+            - name: Install dependencies
+              run: npm install --ignore-scripts
+
+            - name: Run backporting
+              run: npm run backport
+
+    format-and-lint:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Setup repo
+              uses: actions/checkout@v4
+
+            - uses: denoland/setup-deno@v2
+              with:
+                  deno-version: v2.x
+
+            - name: Check Format
+              run: deno fmt --check
+
+            - name: Lint
+              run: deno lint
+
+    test:
+        runs-on: ${{ matrix.os }} # runs a test on Ubuntu, Windows and macOS
+
+        strategy:
+            matrix:
+                os: [macOS-latest, windows-latest, ubuntu-latest]
+
+        steps:
+            - name: Setup repo
+              uses: actions/checkout@v4
+
+            - uses: denoland/setup-deno@v2
+              with:
+                  deno-version: v2.x
+
+            - name: Cache Dependencies
+              run: deno task check
+
+            - name: Run Tests
+              run: deno task test

.gitignore

@@ -0,0 +1,30 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Dependency directories
+node_modules/
+
+# package-lock.json will not be published, so no need to store it
+package-lock.json
+
+# Output of 'npm pack'
+*.tgz
+
+# Test coverage
+test/coverage
+test/cov_profile
+coverage.lcov
+
+# Build output
+out/
+docs/

.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+    "recommendations": ["denoland.vscode-deno"]
+}

.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+    "editor.formatOnSave": true,
+    "editor.codeActionsOnSave": {
+        "source.fixAll": "explicit"
+    }
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 KnorpelSenf
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,60 @@
+# grammY stream
+
+Stream long text messages to Telegram.
+Make LLM output appear as animated message drafts before sending the message.
+Automatically split long text across several messages.
+
+## Quickstart
+
+Run `npm i grammy @grammyjs/stream @grammyjs/auto-retry` and paste the following code:
+
+```ts
+import { Bot, type Context } from "grammy";
+import { autoRetry } from "@grammyjs/auto-retry";
+import { stream, type StreamFlavor } from "@grammyjs/stream";
+
+type MyContext = StreamFlavor<Context>;
+
+const bot = new Bot<MyContext>("");
+
+bot.api.config.use(autoRetry());
+bot.use(stream());
+
+async function* slowText() {
+    // emulate slow text generation
+    yield "This i";
+    await new Promise((r) => setTimeout(r, 1000));
+    yield "s some sl";
+    await new Promise((r) => setTimeout(r, 1000));
+    yield "owly gene";
+    await new Promise((r) => setTimeout(r, 1000));
+    yield "rated text";
+}
+
+bot.command("stream", async (ctx) => {
+    await ctx.replyWithStream(slowText());
+});
+
+bot.command("start", (ctx) => ctx.reply("Hi! Send /stream"));
+bot.use((ctx) => ctx.reply("What a nice update."));
+
+bot.start();
+```
+
+For example, if you use the [AI SDK](https://ai-sdk.dev), your AI setup could look like this:
+
+```ts
+import { streamText } from "ai";
+import { google } from "npm:@ai-sdk/google";
+
+bot.command("credits", async (ctx) => {
+    // Send prompt to LLM:
+    const { textStream } = streamText({
+        model: google("gemini-2.5-flash"),
+        prompt: "How cool are grammY bots?",
+    });
+
+    // Automatically stream response with grammY:
+    await ctx.replyWithStream(textStream);
+});
+```

deno.jsonc

@@ -0,0 +1,21 @@
+{
+    "nodeModulesDir": "none",
+    "lock": false,
+    "tasks": {
+        "check": "deno cache --allow-import --check=all src/mod.ts",
+        "build": "deno run --no-prompt --allow-import --allow-read=. --allow-write=. https://deno.land/x/deno2node@v1.16.0/src/cli.ts tsconfig.json",
+        "test": "deno test --allow-import test",
+        "ok": "deno fmt && deno lint && deno task test && deno task check",
+        "clean": "git clean -fX out"
+    },
+    "exclude": [
+        "./node_modules/",
+        "./out/",
+        "./package-lock.json",
+        "./test/cov_profile"
+    ],
+    "fmt": {
+        "indentWidth": 4,
+        "proseWrap": "preserve"
+    }
+}

package.json

@@ -0,0 +1,45 @@
+{
+    "name": "@grammyjs/stream",
+    "description": "Stream long text messages to Telegram",
+    "version": "0.0.1",
+    "author": "KnorpelSenf",
+    "license": "MIT",
+    "engines": {
+        "node": "^12.20.0 || >=14.13.1"
+    },
+    "homepage": "https://grammy.dev/plugins/stream",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/grammyjs/grammY"
+    },
+    "scripts": {
+        "prepare": "npm run backport",
+        "backport": "deno2node tsconfig.json"
+    },
+    "peerDependencies": {
+        "grammy": "^1.39.0"
+    },
+    "devDependencies": {
+        "@types/node": "^12.20.55",
+        "deno2node": "^1.16.0"
+    },
+    "files": [
+        "out/"
+    ],
+    "main": "./out/mod.js",
+    "types": "./out/mod.d.ts",
+    "keywords": [
+        "telegram",
+        "bot",
+        "api",
+        "client",
+        "framework",
+        "library",
+        "grammy",
+        "stream",
+        "draft",
+        "ai",
+        "llm",
+        "model"
+    ]
+}

src/README.md

@@ -0,0 +1,5 @@
+# grammY stream
+
+This plugin simplifies streaming text (including LLM output) to Telegram.
+
+Check out the [main page of the repository](https://github.com/grammyjs/stream).

src/deps.deno.ts

@@ -0,0 +1,10 @@
+export {
+    type Context,
+    type MiddlewareFn,
+    type RawApi,
+} from "https://lib.deno.dev/x/grammy@v1/mod.ts";
+export type {
+    ApiMethods,
+    Message,
+    MessageEntity,
+} from "https://lib.deno.dev/x/grammy@v1/types.ts";