Add README.md

The feature of editing text messages and captions is also added in this commit

.gitignore

@@ -0,0 +1,179 @@
+# Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore
+
+# Logs
+
+logs
+_.log
+npm-debug.log_
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Caches
+
+.cache
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+
+report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
+
+# Runtime data
+
+pids
+_.pid
+_.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+
+lib-cov
+
+# Coverage directory used by tools like istanbul
+
+coverage
+*.lcov
+
+# nyc test coverage
+
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+
+bower_components
+
+# node-waf configuration
+
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+
+build/Release
+
+# Dependency directories
+
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+
+web_modules/
+
+# TypeScript cache
+
+*.tsbuildinfo
+
+# Optional npm cache directory
+
+.npm
+
+# Optional eslint cache
+
+.eslintcache
+
+# Optional stylelint cache
+
+.stylelintcache
+
+# Microbundle cache
+
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+
+.node_repl_history
+
+# Output of 'npm pack'
+
+*.tgz
+
+# Yarn Integrity file
+
+.yarn-integrity
+
+# dotenv environment variable files
+
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+
+.parcel-cache
+
+# Next.js build output
+
+.next
+out
+
+# Nuxt.js build / generate output
+
+.nuxt
+dist
+
+# Gatsby files
+
+# Comment in the public line in if your project uses Gatsby and not Next.js
+
+# https://nextjs.org/blog/next-9-1#public-directory-support
+
+# public
+
+# vuepress build output
+
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+
+.temp
+
+# Docusaurus cache and generated files
+
+.docusaurus
+
+# Serverless directories
+
+.serverless/
+
+# FuseBox cache
+
+.fusebox/
+
+# DynamoDB Local files
+
+.dynamodb/
+
+# TernJS port file
+
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+
+.vscode-test
+
+# yarn v2
+
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+# IntelliJ based IDEs
+.idea
+
+# Finder (MacOS) folder config
+.DS_Store
+
+# Custom ignores
+config.env
+database.sqlite

README.md

@@ -0,0 +1,40 @@
+# Magical MailBox 🪄
+
+A magic mailbox where people can deliver their mails to you anonymously. And you read them and answer . 😉 This mailbox also has some magical features. The sent letters can be edited or you can react to them. 🥰✨
+
+**This mailbox does support:**
+
+- 💬 Text
+- 🔉 Voice/Audio
+- 🎞 Video/Video note
+- 🎆 Sticker/Gif
+- 📁 Document
+- 🥰 Reactions
+
+## Commands
+
+| Command  | Description                     | Accessibility |
+| -------- | ------------------------------- | ------------- |
+| /start   | Show supported formats          | All users     |
+| /block   | Block a sender messages         | Admin         |
+| /unblock | Unblock blocked sender messages | Admin         |
+
+## Usage
+
+How to use it is simple. The senders just need to send their message like a normal message and the admin just needs to reply to the messages he receives to answer them. You can also use the command "/block" and "/unblock" when replying to a message.
+
+## Setup and deploy bot
+
+1.  Install [Bun](https://bun.sh)
+2.  Download latest version from [Releases](https://github.com/sudospaes/magical-mailbox/releases)
+3.  Extract downloaded zip
+4.  Move to extracted directory
+5.  Run `bun i` to install dependencies
+6.  Create `config.env` in the current directory and paste these in that
+
+```env
+token=your_telegram_bot_token
+admin=your_user_id // You can get it from @userinfobot
+```
+
+7. Run `bun start`

package.json

@@ -0,0 +1,24 @@
+{
+  "name": "magical-mailbox",
+  "version": "0.0.1",
+  "module": "app.ts",
+  "type": "module",
+  "license": "MIT",
+  "description": "",
+  "peerDependencies": {
+    "typescript": "^5.5.4"
+  },
+  "devDependencies": {
+    "@types/bun": "latest"
+  },
+  "dependencies": {
+    "dotenv": "^16.4.5",
+    "grammy": "^1.29.0",
+    "sequelize": "^6.37.3",
+    "sqlite3": "^5.1.7"
+  },
+  "scripts": {
+    "start": "bun run src/app.ts",
+    "dev": "bun run --watch src/app.ts"
+  }
+}

src/app.ts

@@ -0,0 +1,25 @@
+import { Bot } from "grammy";
+
+import { connectToDatabase, setupEnv } from "utils/utils";
+
+import messages from "composer/messages";
+import commands from "composer/commands";
+import edits from "composer/edits";
+
+await connectToDatabase();
+await setupEnv();
+
+const bot = new Bot(process.env.token!);
+
+bot.use(commands);
+bot.use(messages);
+bot.use(edits);
+
+bot.start({
+  allowed_updates: [
+    "message",
+    "edited_message",
+    "message_reaction",
+    "message_reaction_count",
+  ],
+});

src/composer/commands.ts

@@ -0,0 +1,68 @@
+import { Composer } from "grammy";
+
+import Archive from "models/archive";
+import BlockList from "models/block-list";
+
+const commands = new Composer();
+const env = process.env;
+
+commands.command("start", (ctx) => {
+  ctx.reply("Welcome to my magical mailbox 🪄");
+  ctx.reply(`My mailbox does support:
+      💬 Text
+      🔉 Voice/Audio
+      🎞 Video/Video note
+      🎆 Sticker/Gif
+      📁 Document
+      🥰 Reactions`);
+});
+
+commands.command("block", async (ctx) => {
+  if (ctx.chatId != +env.admin!) return ctx.reply("You are not owner");
+  if (!ctx.msg.reply_to_message)
+    return ctx.reply("Please reply on a message to block it sender");
+  try {
+    const record: any = await Archive.findOne({
+      where: { msgId: ctx.msg.reply_to_message.message_id },
+    });
+    if (record.senderId == +env.admin!)
+      return ctx.reply("Owner can't block itself");
+    const isSenderBlocked = await BlockList.findOne({
+      where: { senderId: record.senderId },
+    });
+    if (!isSenderBlocked) {
+      await BlockList.create({ senderId: record.senderId });
+      return ctx.reply("The sender has been blocked");
+    } else {
+      return ctx.reply("The sender blocked before");
+    }
+  } catch (err) {
+    console.log(err);
+  }
+});
+
+commands.command("unblock", async (ctx) => {
+  if (ctx.chatId != +env.admin!) return ctx.reply("You are not owner");
+  if (!ctx.msg.reply_to_message)
+    return ctx.reply("Please reply on a message to make unblock it sender");
+  try {
+    const record: any = await Archive.findOne({
+      where: { msgId: ctx.msg.reply_to_message.message_id },
+    });
+    if (record.senderId == +env.admin!)
+      return ctx.reply("Owner is free forever");
+    const isSenderBlocked = await BlockList.findOne({
+      where: { senderId: record.senderId },
+    });
+    if (isSenderBlocked) {
+      await BlockList.destroy({ where: { senderId: record.senderId } });
+      return ctx.reply("The sender is a freebird from now");
+    } else {
+      return ctx.reply("The sender is already free");
+    }
+  } catch (err) {
+    console.log(err);
+  }
+});
+
+export default commands;

src/composer/edits.ts

@@ -0,0 +1,39 @@
+import { Composer } from "grammy";
+
+import Archive from "models/archive";
+
+const edits = new Composer();
+
+edits.on("edit:text", async (ctx) => {
+  try {
+    const record: any = await Archive.findOne({
+      where: { senderMsgId: ctx.msgId },
+    });
+    const receiverId =
+      ctx.chat.id == record.receiverId ? record.senderId : record.receiverId;
+    await ctx.api.editMessageText(
+      receiverId,
+      record.msgId,
+      ctx.editedMessage?.text!
+    );
+  } catch (err) {
+    console.log(err);
+  }
+});
+
+edits.on("edit:caption", async (ctx, next) => {
+  try {
+    const record: any = await Archive.findOne({
+      where: { senderMsgId: ctx.msgId },
+    });
+    const receiverId =
+      ctx.chat.id == record.receiverId ? record.senderId : record.receiverId;
+    await ctx.api.editMessageCaption(receiverId, record.msgId, {
+      caption: ctx.editedMessage?.caption,
+    });
+  } catch (err) {
+    console.log(err);
+  }
+});
+
+export default edits;

src/composer/messages.ts

@@ -0,0 +1,81 @@
+import { Composer } from "grammy";
+
+import Archive from "models/archive";
+import BlockList from "models/block-list";
+
+const messages = new Composer();
+const env = process.env;
+
+messages.on("message", async (ctx, next) => {
+  try {
+    const isSenderBlocked = await BlockList.findOne({
+      where: { senderId: ctx.from.id },
+    });
+    if (isSenderBlocked)
+      return ctx.reply("Sorry, You aren't allowed to send message 💔");
+    else next();
+  } catch (err) {
+    console.log(err);
+  }
+});
+
+// Handle reply messages
+messages.on("message", async (ctx, next) => {
+  if (!ctx.msg.reply_to_message) return next();
+  try {
+    const record: any = await Archive.findOne({
+      where: { msgId: ctx.msg.reply_to_message.message_id },
+    });
+    const msg = await ctx.api.copyMessage(
+      record.senderId,
+      ctx.from.id,
+      ctx.msgId,
+      {
+        reply_parameters: { message_id: record.senderMsgId },
+      }
+    );
+    const receiverId = ctx.from.id != +env.admin! ? env.admin : record.senderId;
+    await Archive.create({
+      msgId: msg.message_id,
+      senderId: ctx.from.id,
+      senderMsgId: ctx.msgId,
+      receiverId: receiverId,
+    });
+  } catch (err) {
+    console.log(err);
+  }
+});
+
+// Handle messaging
+messages.on("message", async (ctx) => {
+  try {
+    const msg = await ctx.api.copyMessage(env.admin!, ctx.from.id, ctx.msgId);
+    const receiverId = ctx.from.id != +env.admin! ? env.admin : ctx.from.id;
+    await Archive.create({
+      msgId: msg.message_id,
+      senderId: ctx.from.id,
+      senderMsgId: ctx.msgId,
+      receiverId: receiverId,
+    });
+  } catch (err) {
+    console.log(err);
+  }
+});
+
+// Handle reaction on messages
+messages.on("message_reaction", async (ctx) => {
+  try {
+    const record: any = await Archive.findOne({
+      where: { msgId: ctx.msgId },
+    });
+    await ctx.api.setMessageReaction(
+      record.senderId,
+      record.senderMsgId,
+      ctx.messageReaction.new_reaction
+    );
+  } catch (err) {
+    console.log(err);
+  }
+});
+
+export default messages;

src/database.ts

@@ -0,0 +1,12 @@
+import { Sequelize } from "sequelize";
+
+import { join } from "path";
+
+import { rootPath } from "utils/utils";
+
+const database = new Sequelize({
+  dialect: "sqlite",
+  storage: join(rootPath(), "database.sqlite"),
+});
+
+export default database;

src/models/archive.ts

@@ -0,0 +1,29 @@
+import { DataTypes } from "sequelize";
+
+import database from "database";
+
+const Archive = database.define(
+  "Archive",
+  {
+    msgId: {
+      type: DataTypes.INTEGER,
+      primaryKey: true,
+      allowNull: false,
+    },
+    senderId: {
+      type: DataTypes.INTEGER,
+      allowNull: false,
+    },
+    senderMsgId: {
+      type: DataTypes.INTEGER,
+      allowNull: false,
+    },
+    receiverId: {
+      type: DataTypes.INTEGER,
+      allowNull: false,
+    },
+  },
+  { timestamps: false }
+);
+
+export default Archive;

src/models/block-list.ts

@@ -0,0 +1,17 @@
+import { DataTypes } from "sequelize";
+
+import database from "database";
+
+const BlockList = database.define(
+  "BlockList",
+  {
+    senderId: {
+      type: DataTypes.INTEGER,
+      primaryKey: true,
+      allowNull: false,
+    },
+  },
+  { timestamps: false }
+);
+
+export default BlockList;

src/utils/utils.ts

@@ -0,0 +1,36 @@
+import { config } from "dotenv";
+
+import { join } from "path";
+
+import database from "database";
+
+export function rootPath() {
+  return process.cwd();
+}
+
+export async function connectToDatabase() {
+  try {
+    await database.authenticate();
+    console.log("Connection has been established successfully.");
+    await database.sync();
+    console.log("Sync has been done successfully.");
+  } catch (error) {
+    console.error("Unable to use the database:", error);
+  }
+}
+
+export async function setupEnv() {
+  try {
+    await config({ path: join(rootPath(), "config.env") });
+  } catch (err) {
+    console.log(err);
+  }
+  if (!process.env.token) {
+    console.log("Bot token is not exist in the config file.");
+    process.exit(1);
+  }
+  if (!process.env.admin) {
+    console.log("Bot admin id is not not exist in the config file.");
+    process.exit(1);
+  }
+}

tsconfig.json

@@ -0,0 +1,33 @@
+{
+  "compilerOptions": {
+    // Enable latest features
+    "lib": ["ESNext", "DOM"],
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleDetection": "force",
+    "jsx": "react-jsx",
+    "allowJs": true,
+
+    // Bundler mode
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "noEmit": true,
+
+    // Best practices
+    "strict": true,
+    "skipLibCheck": true,
+    "noFallthroughCasesInSwitch": true,
+
+    // Some stricter flags (disabled by default)
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "noPropertyAccessFromIndexSignature": false,
+    "baseUrl": "src",
+    "paths": {
+      "@src/*": ["src/*"],
+      "@utils/*": ["src/utils/*"],
+      "@models/*": ["src/models/*"]
+    },
+  }
+}