@effect-ak/tg-bot-client 0.0.2

package/dist/esm/client/const.js

@@ -0,0 +1,12 @@
+export const MESSAGE_EFFECTS = {
+    "🔥": "5104841245755180586",
+    "👍": "5107584321108051014",
+    "👎": "5104858069142078462",
+    "❤️": "5159385139981059251",
+    "🎉": "5046509860389126442",
+    "💩": "5046589136895476101"
+};
+export const messageEffectIdCodes = Object.keys(MESSAGE_EFFECTS);
+export const isMessageEffect = (input) => {
+    return typeof input === "string" && input in MESSAGE_EFFECTS;
+};

package/dist/esm/client/factory.js

@@ -0,0 +1,23 @@
+import { makePayload, methodPath } from "./request.js";
+import { isTgBotApiResponse } from "./response.js";
+const defaultBaseUrl = "https://api.telegram.org";
+export const makeTgBotClient = (options) => {
+    const baseUrl = options.baseUrl ?? defaultBaseUrl;
+    const execute = async (method, input) => {
+        const httpResponse = await fetch(`${baseUrl}/bot${options.token}/${methodPath(method)}`, {
+            body: makePayload(input) ?? null,
+            method: "POST"
+        }).then(_ => _.json());
+        if (!isTgBotApiResponse(httpResponse))
+            throw new Error("Not valid response", {
+                cause: httpResponse
+            });
+        if (httpResponse.ok == false) {
+            console.warn(httpResponse);
+        }
+        return httpResponse;
+    };
+    return {
+        execute
+    };
+};

package/dist/esm/client/request.js

@@ -0,0 +1,33 @@
+export const methodPath = (methodName) => methodName
+    .split("_")
+    .reduce((result, word, step) => {
+    if (step == 0) {
+        return word;
+    }
+    else {
+        return result + word.at(0)?.toUpperCase() + word.slice(1);
+    }
+}, "");
+const hasFileContent = (input) => (typeof input == "object" && input != null) &&
+    ("file_content" in input && input.file_content instanceof Uint8Array) &&
+    ("file_name" in input && typeof input.file_name === "string" && input.file_name.length > 0);
+export const makePayload = (body) => {
+    const entries = Object.entries(body);
+    if (entries.length == 0)
+        return undefined;
+    const result = new FormData();
+    for (const [key, value] of entries) {
+        if (!value)
+            continue;
+        if (typeof value != "object") {
+            result.append(key, `${value}`);
+        }
+        else if (hasFileContent(value)) {
+            result.append(key, new Blob([value.file_content]), value.file_name);
+        }
+        else {
+            result.append(key, JSON.stringify(value));
+        }
+    }
+    return result;
+};

package/dist/esm/client/response.js

@@ -0,0 +1,6 @@
+export const isTgBotApiResponse = (input) => {
+    return (("ok" in input && typeof input.ok == "boolean") &&
+        (typeof input.error_code === 'undefined' || typeof input.error_code === 'number') &&
+        (typeof input.description === 'undefined' || typeof input.description === 'string') &&
+        (typeof input.result === 'undefined' || typeof input.result === 'object'));
+};

package/dist/esm/index.js

@@ -0,0 +1,4 @@
+export * from "./client/const.js";
+export * from "./client/factory.js";
+export * from "./specification/api.js";
+export * from "./specification/types.js";

package/dist/esm/specification/api.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/specification/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@effect-ak/tg-bot-client",
+  "version": "0.0.2",
+  "type": "module",
+  "author": {
+    "name": "Aleksandr Kondaurov",
+    "email": "kondaurov.dev@gmail.com"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "description": "Telegram bot client",
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "telegram",
+    "telegram bot api"
+  ],
+  "repository": {
+    "url": "https://github.com/kondaurovDev/effect-ak/tg-bot-client"
+  },
+  "license": "MIT",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/dts/index.d.ts",
+  "devDependencies": {
+    "@babel/cli": "^7.26.4",
+    "@babel/core": "^7.26.0",
+    "@babel/plugin-transform-export-namespace-from": "^7.25.9",
+    "@babel/plugin-transform-modules-commonjs": "^7.26.3",
+    "@types/node": "^22.10.1",
+    "effect": "^3.11.4",
+    "node-html-parser": "^6.1.13",
+    "ts-morph": "^24.0.0",
+    "tsc-alias": "^1.8.10",
+    "typescript": "^5.7.2",
+    "vitest": "^2.1.8",
+    "vite-tsconfig-paths": "^5.1.4"
+  },
+  "scripts": {
+    "build": "pnpm build-esm && pnpm build-cjs",
+    "build-esm": "tsc -p tsconfig.build.json && tsc-alias -p tsconfig.build.json",
+    "build-cjs": "babel dist/esm --out-dir dist/cjs"
+  }
+}

package/readme.md

@@ -0,0 +1,74 @@
+![NPM Version](https://img.shields.io/npm/v/%40effect-ak%2Ftg-bot-client)
+
+### What is it? 
+
+This is a client for interacting with the Telegram Bot API.  
+The main reason for creating this package is that Telegram does not provide an SDK for working with their API.
+
+They only provide documentation in the form of a massive HTML page, which is very inconvenient for navigating and understanding what the Telegram Bot API offers.
+
+## Features:
+- **Pure TypeScript Client**: This is a clean client written in TypeScript with no abstractions.
+- **Complete**: The entire API is generated from the official documentation [https://core.telegram.org/bots/api](https://core.telegram.org/bots/api) using a [code generator](./codegen/main.ts).
+- **Inline Documentation**: No need to read lengthy official documentation. All types and comments are available in JS DOC, allowing you to develop your bot without leaving your IDE.
+- **Type Mapping**: Types from the documentation are converted to TypeScript types. For example, `Integer` becomes `number`, `True` becomes `boolean`, `String or Number` becomes `string | number`, and so on.
+- **Readable Method Names**: Method names, such as `SetChatAdministratorCustomTitleInput`, are converted to snake_case for easier code readability, e.g., `set_chat_administrator_custom_title`.
+
+### Usage example
+
+#### Install
+
+`npm i @effect-ak/tg-bot-client`
+
+#### Creating a Client
+
+```typescript
+import { makeTgBotClient } from "effect-ak/tg-bot-client"
+
+const client = makeTgBotClient({
+  token: "" //your token from bot father
+});
+```
+
+Now, `client` is an object that has an `execute` method. This method takes two arguments: the first is the API method, and the second is an object containing the arguments for that method.
+
+#### 1. Sending a Message with an Effect
+
+```typescript
+import { MESSAGE_EFFECTS } from "effect-ak/tg-bot-client"
+
+await client.execute("send_message", {
+  chat_id: "???", // replace ??? with the chat number
+  text: "hey again",
+  message_effect_id: MESSAGE_EFFECTS["🔥"]
+});
+```
+
+#### 2. Sending a Dice
+
+```typescript
+await client.execute("send_dice", {
+  chat_id: "???", // replace ??? with the chat number
+  emoji: "🎲"
+});
+```
+
+#### 3. Sending a Document
+
+```typescript
+await client.execute("send_document", {
+  chat_id: "???", // replace ??? with the chat number
+  message_effect_id: MESSAGE_EFFECTS["🎉"],
+  document: {
+    file_content: Buffer.from("Hello!"),
+    file_name: "hello.txt"
+  },
+  caption: "simple text file"
+})
+```
+
+---
+
+### Summary
+
+This code generator and client will continue to be developed. However, for now, I have generated all the methods and types. If you find any errors, please let me know.