@effect-ak/tg-bot-client 0.0.2 → 0.0.4

package/dist/cjs/client/_client.js

@@ -0,0 +1,22 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.makeTgBotClient = void 0;
+var _executeRequest = require("./execute-request.js");
+var _downloadFile = require("./download-file.js");
+const defaultBaseUrl = "https://api.telegram.org";
+const makeTgBotClient = inputConfig => {
+  const config = {
+    ...inputConfig,
+    baseUrl: inputConfig.baseUrl ?? defaultBaseUrl
+  };
+  const execute = (0, _executeRequest.makeExecute)(config);
+  const file = (0, _downloadFile.makeDownloadFile)(config, execute);
+  return {
+    execute,
+    ...file
+  };
+};
+exports.makeTgBotClient = makeTgBotClient;

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

@@ -0,0 +1,25 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.makeDownloadFile = void 0;
+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 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;
+  };
+  return {
+    getFile
+  };
+};
+exports.makeDownloadFile = makeDownloadFile;

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

@@ -0,0 +1,32 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.makeExecute = void 0;
+var _request = require("./request.js");
+var _response = require("./response.js");
+const makeExecute = config => {
+  const execute = async (method, input) => {
+    const httpResponse = await fetch(`${config.baseUrl}/bot${config.token}/${snakeToCamel(method)}`, {
+      body: (0, _request.makePayload)(input) ?? null,
+      method: "POST"
+    }).then(_ => _.json());
+    if (!(0, _response.isTgBotApiResponse)(httpResponse)) throw new Error("Not valid response", {
+      cause: httpResponse
+    });
+    if (httpResponse.ok == false) {
+      console.warn(httpResponse);
+    }
+    return httpResponse;
+  };
+  return execute;
+};
+exports.makeExecute = makeExecute;
+const snakeToCamel = methodName => methodName.split("_").reduce((result, word, step) => {
+  if (step == 0) {
+    return word;
+  } else {
+    return result + word.at(0)?.toUpperCase() + word.slice(1);
+  }
+}, "");

package/dist/cjs/client/request.js

@@ -3,15 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.methodPath = exports.makePayload = void 0;
-const methodPath = methodName => methodName.split("_").reduce((result, word, step) => {
-  if (step == 0) {
-    return word;
-  } else {
-    return result + word.at(0)?.toUpperCase() + word.slice(1);
-  }
-}, "");
-exports.methodPath = methodPath;
+exports.makePayload = void 0;
 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;
 const makePayload = body => {
   const entries = Object.entries(body);

package/dist/cjs/index.js

@@ -14,14 +14,14 @@ Object.keys(_const).forEach(function (key) {
     }
   });
 });
-var _factory = require("./client/factory.js");
-Object.keys(_factory).forEach(function (key) {
+var _client = require("./client/_client.js");
+Object.keys(_client).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _factory[key]) return;
+  if (key in exports && exports[key] === _client[key]) return;
   Object.defineProperty(exports, key, {
     enumerable: true,
     get: function () {
-      return _factory[key];
+      return _client[key];
     }
   });
 });

package/dist/dts/client/_client.d.ts

@@ -0,0 +1,12 @@
+import type { SetOptional } from "type-fest";
+export type BotConfig = {
+    token: string;
+    baseUrl: string;
+};
+export type TgBotClient = ReturnType<typeof makeTgBotClient>;
+export declare const makeTgBotClient: (inputConfig: SetOptional<BotConfig, "baseUrl">) => {
+    readonly getFile: (input: {
+        file_id: string;
+    }) => Promise<import("buffer").File>;
+    readonly execute: <M extends keyof import("../index.js").Api>(method: M, input: Parameters<import("../index.js").Api[M]>[0]) => Promise<import("./response.js").TgBotApiResponse<ReturnType<import("../index.js").Api[M]>>>;
+};

package/dist/dts/client/download-file.d.ts

@@ -0,0 +1,7 @@
+import type { BotConfig } from "./_client.js";
+import type { ExecuteRequest } from "./execute-request.js";
+export declare const makeDownloadFile: (config: BotConfig, execute: ExecuteRequest) => {
+    readonly getFile: (input: {
+        file_id: string;
+    }) => Promise<import("buffer").File>;
+};

package/dist/dts/client/execute-request.d.ts

@@ -0,0 +1,5 @@
+import type { BotConfig } from "./_client.js";
+import type { Api } from "../specification/api.js";
+import { TgBotApiResponse } from "./response.js";
+export type ExecuteRequest = ReturnType<typeof makeExecute>;
+export declare const makeExecute: (config: BotConfig) => <M extends keyof Api>(method: M, input: Parameters<Api[M]>[0]) => Promise<TgBotApiResponse<ReturnType<Api[M]>>>;

package/dist/dts/client/request.d.ts

@@ -1,2 +1 @@
-export declare const methodPath: (methodName: string) => string;
 export declare const makePayload: (body: Record<string, unknown>) => FormData | undefined;

package/dist/dts/index.d.ts

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

package/dist/esm/client/_client.js

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

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

@@ -0,0 +1,17 @@
+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 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;
+    };
+    return {
+        getFile
+    };
+};

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

@@ -0,0 +1,29 @@
+import { makePayload } from "./request.js";
+import { isTgBotApiResponse } from "./response.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
+            });
+        if (httpResponse.ok == false) {
+            console.warn(httpResponse);
+        }
+        return httpResponse;
+    };
+    return execute;
+};
+const snakeToCamel = (methodName) => methodName
+    .split("_")
+    .reduce((result, word, step) => {
+    if (step == 0) {
+        return word;
+    }
+    else {
+        return result + word.at(0)?.toUpperCase() + word.slice(1);
+    }
+}, "");

package/dist/esm/client/request.js

@@ -1,13 +1,3 @@
-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);

package/dist/esm/index.js

@@ -1,4 +1,4 @@
 export * from "./client/const.js";
-export * from "./client/factory.js";
+export * from "./client/_client.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.2",
+  "version": "0.0.4",
   "type": "module",
   "author": {
     "name": "Aleksandr Kondaurov",
@@ -18,7 +18,7 @@
     "telegram bot api"
   ],
   "repository": {
-    "url": "https://github.com/kondaurovDev/effect-ak/tg-bot-client"
+    "url": "https://github.com/effect-ak/tg-bot-client"
   },
   "license": "MIT",
   "main": "./dist/cjs/index.js",
@@ -34,9 +34,10 @@
     "node-html-parser": "^6.1.13",
     "ts-morph": "^24.0.0",
     "tsc-alias": "^1.8.10",
+    "type-fest": "^4.30.0",
     "typescript": "^5.7.2",
-    "vitest": "^2.1.8",
-    "vite-tsconfig-paths": "^5.1.4"
+    "vite-tsconfig-paths": "^5.1.4",
+    "vitest": "^2.1.8"
   },
   "scripts": {
     "build": "pnpm build-esm && pnpm build-cjs",

package/readme.md

@@ -67,6 +67,23 @@ await client.execute("send_document", {
 })
 ```
 
+
+#### 4. Getting a file
+
+In order to download file from Telegram server we need to send two http requests:
+1. execute `get_file` and get `remote_path`
+2. get file content via GET request with different url
+
+`client.getFile` does exactly that. It returns [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File)
+
+```typescript
+const file = 
+  await client.getFile({ 
+    file_id: fileId
+  });
+// file is File
+```
+
 ---
 
 ### Summary