@effect-ak/tg-bot-client 0.0.7 → 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,

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/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.7",
+  "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
@@ -44,7 +53,7 @@ if you want, you can use unsafe alternative, `unsafeExecute`, which gives you th
 #### 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