@effect-ak/tg-bot-client 0.0.6 → 0.1.0

package/dist/esm/client/_client.js

@@ -1,6 +1,6 @@
 import { makeExecute } from "./execute-request.js";
 import { makeDownloadFile } from "./download-file.js";
-const defaultBaseUrl = "https://api.telegram.org";
+import { defaultBaseUrl } from "./const.js";
 export const makeTgBotClient = (inputConfig) => {
     const config = {
         ...inputConfig,
@@ -9,7 +9,7 @@ export const makeTgBotClient = (inputConfig) => {
     const execute = makeExecute(config);
     const file = makeDownloadFile(config, execute);
     return {
-        execute,
+        ...execute,
         ...file
     };
 };

package/dist/esm/client/const.js

@@ -1,3 +1,4 @@
+export const defaultBaseUrl = "https://api.telegram.org";
 export const MESSAGE_EFFECTS = {
     "🔥": "5104841245755180586",
     "👍": "5107584321108051014",

package/dist/esm/client/download-file.js

@@ -1,15 +1,34 @@
+import { TgBotClientError } from "./errors.js";
 export const makeDownloadFile = (config, execute) => {
     const getFile = async (input) => {
-        const response = await execute("get_file", input);
-        response.result?.file_path;
-        const file_path = response.result?.file_path;
-        if (!file_path || file_path.length == 0)
-            throw new Error("NoFilePath", { cause: response });
+        const response = await execute.execute("get_file", input);
+        if (response.error)
+            return { error: response.error };
+        const file_path = response.success?.file_path;
+        if (!file_path || file_path.length == 0) {
+            return {
+                error: new TgBotClientError({
+                    type: "UnableToGetFile",
+                    cause: "File path not defined"
+                })
+            };
+        }
         const file_name = file_path.replaceAll("/", "-");
         const url = `${config.baseUrl}/file/bot${config.token}/${file_path}`;
-        const fileContent = await fetch(url).then(_ => _.arrayBuffer());
-        const file = new File([new Uint8Array(fileContent)], file_name);
-        return file;
+        try {
+            const fileContent = await fetch(url).then(_ => _.arrayBuffer());
+            const file = new File([new Uint8Array(fileContent)], file_name);
+            return {
+                success: file
+            };
+        }
+        catch (cause) {
+            return {
+                error: new TgBotClientError({
+                    type: "UnableToGetFile", cause
+                })
+            };
+        }
     };
     return {
         getFile

package/dist/esm/client/errors.js

@@ -0,0 +1,12 @@
+export class TgBotClientError extends Error {
+    reason;
+    _tag = "TgBotClientError";
+    constructor(reason) {
+        super();
+        this.reason = reason;
+    }
+    static missingSuccess = new TgBotClientError({
+        type: "ClientInternalError",
+        cause: "Expected 'success' to be defined"
+    });
+}

package/dist/esm/client/execute-request.js

@@ -1,21 +1,54 @@
 import { makePayload } from "./request.js";
 import { isTgBotApiResponse } from "./response.js";
+import { TgBotClientError } from "./errors.js";
 export const makeExecute = (config) => {
     const execute = async (method, input) => {
-        const httpResponse = await fetch(`${config.baseUrl}/bot${config.token}/${snakeToCamel(method)}`, {
-            body: makePayload(input) ?? null,
-            method: "POST"
-        }).then(_ => _.json());
-        if (!isTgBotApiResponse(httpResponse))
-            throw new Error("Not valid response", {
-                cause: httpResponse
+        try {
+            const httpResponse = await fetch(`${config.baseUrl}/bot${config.token}/${snakeToCamel(method)}`, {
+                body: makePayload(input) ?? null,
+                method: "POST",
             });
-        if (httpResponse.ok == false) {
-            console.warn(httpResponse);
+            const response = await httpResponse.json();
+            if (!isTgBotApiResponse(response)) {
+                return {
+                    error: new TgBotClientError({
+                        type: "UnexpectedResponse",
+                        response
+                    })
+                };
+            }
+            if (!httpResponse.ok) {
+                return {
+                    error: new TgBotClientError({
+                        type: "NotOkResponse",
+                        ...(response.error_code ? { errorCode: response.error_code } : undefined),
+                        ...(response.description ? { details: response.description } : undefined)
+                    })
+                };
+            }
+            return {
+                success: response.result
+            };
         }
-        return httpResponse;
+        catch (cause) {
+            return {
+                error: new TgBotClientError({
+                    type: "ClientInternalError", cause
+                })
+            };
+        }
+    };
+    const unsafeExecute = async (method, input) => {
+        const result = await execute(method, input);
+        if (result.error)
+            throw result.error;
+        if (!("success" in result))
+            throw TgBotClientError.missingSuccess;
+        return result.success;
+    };
+    return {
+        execute, unsafeExecute
     };
-    return execute;
 };
 const snakeToCamel = (methodName) => methodName
     .split("_")

package/dist/esm/client/response.js

@@ -1,6 +1,15 @@
 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'));
+    if (typeof input !== "object" || input == null) {
+        return false;
+    }
+    if (!("ok" in input && typeof input.ok == "boolean")) {
+        return false;
+    }
+    if ("error_code" in input && typeof input.error_code != "number") {
+        return false;
+    }
+    if ("description" in input && typeof input.description != "string") {
+        return false;
+    }
+    return true;
 };

package/dist/esm/index.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@effect-ak/tg-bot-client",
-  "version": "0.0.6",
+  "version": "0.1.0",
   "type": "module",
   "author": {
     "name": "Aleksandr Kondaurov",
@@ -32,17 +32,20 @@
     "@types/node": "^22.10.1",
     "effect": "^3.11.4",
     "node-html-parser": "^6.1.13",
+    "openapi-types": "^12.1.3",
     "ts-morph": "^24.0.0",
     "tsc-alias": "^1.8.10",
     "type-fest": "^4.30.0",
     "typescript": "^5.7.2",
     "vite-tsconfig-paths": "^5.1.4",
-    "vitest": "^2.1.8"
+    "vitest": "^2.1.8",
+    "@redocly/cli": "^1.26.0"
   },
   "scripts": {
-    "gen": "bun run codegen/main",
+    "gen": "bun run ./codegen/main",
     "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"
+    "build-cjs": "babel dist/esm --out-dir dist/cjs",
+    "gen-html": "redocly build-docs --output ../effect-ak.github.io/telegram-bot-api/index.html"
   }
 }

package/readme.md

@@ -1,5 +1,7 @@
 ![NPM Version](https://img.shields.io/npm/v/%40effect-ak%2Ftg-bot-client)
 
+[OpenApi Specification](https://effect-ak.github.io/telegram-bot-api/)
+
 ### What is it? 
 
 This is a client for interacting with the Telegram Bot API.  
@@ -10,8 +12,15 @@ They only provide documentation in the form of a massive HTML page, which is ver
 ## 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.
+- ~~**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.~~
+  - Codegenerator produces TypeScript code and OpenApi specification now! Documentation was removed from TypeScript interfaces in order to keep npm package smaller.
+
+- **Type Mapping**: Types from the documentation are converted to TypeScript types:
+  - `Integer` becomes `number`
+  - `True` becomes `boolean`
+  - `String or Number` becomes `string | number`
+  - Enumerated types, such as `Type of the chat, can be either “private”, “group”, “supergroup” or “channel”` becomes a standard union of literal types `"private"| "group" | "supergroup" | "channel"`
+  - 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
@@ -23,19 +32,28 @@ They only provide documentation in the form of a massive HTML page, which is ver
 #### Creating a Client
 
 ```typescript
-import { makeTgBotClient } from "effect-ak/tg-bot-client"
+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.
+#### Executing api methods, typesafety
+
+`client` has an `execute` method which requires two arguments
+
+- the first is the API method, e.g. `send_message`
+- the second is an object containing the arguments for that method, e.g. `text`
+
+`execute` never returns failed promise, instead, it gives an object with two fields, `success`, `error`.
+
+if you want, you can use unsafe alternative, `unsafeExecute`, which gives you the result of method or throws an Error
 
 #### 1. Sending a Message with an Effect
 
 ```typescript
-import { MESSAGE_EFFECTS } from "effect-ak/tg-bot-client"
+import { MESSAGE_EFFECTS } from "@effect-ak/tg-bot-client"
 
 await client.execute("send_message", {
   chat_id: "???", // replace ??? with the chat number