@effect-ak/tg-bot-client 0.6.4 → 1.0.0

package/dist/index.mjs

@@ -1 +0,0 @@
-import*as C from"effect/String";import*as p from"effect/Micro";import*as M from"effect/Data";var a=class extends M.TaggedError("TgBotClientError"){};var T=e=>typeof e=="object"&&e!=null&&"file_content"in e&&e.file_content instanceof Uint8Array&&"file_name"in e&&typeof e.file_name=="string",k=e=>typeof e=="object"&&e!=null&&"ok"in e&&typeof e.ok=="boolean",U=e=>typeof e=="object"&&e!=null&&"update_id"in e&&typeof e.update_id=="number";import*as g from"effect/Context";var F="https://api.telegram.org",_={"\u{1F525}":"5104841245755180586","\u{1F44D}":"5107584321108051014","\u{1F44E}":"5104858069142078462","\u2764\uFE0F":"5159385139981059251","\u{1F389}":"5046509860389126442","\u{1F4A9}":"5046589136895476101"},P=Object.keys(_),v=e=>typeof e=="string"&&e in _;var m=class extends g.Reference()("TgBotApiBaseUrl",{defaultValue:()=>F}){},l=class extends g.Tag("TgBotApiToken")(){};var B=e=>{let s=Object.entries(e);if(s.length==0)return;let t=new FormData;for(let[r,o]of s)o&&(typeof o!="object"?t.append(r,`${o}`):T(o)?t.append(r,new Blob([o.file_content]),o.file_name):t.append(r,JSON.stringify(o)));return t};var u=(e,s)=>p.gen(function*(){let t=yield*p.service(l),r=yield*p.service(m),o=yield*p.tryPromise({try:()=>fetch(`${r}/bot${t}/${C.snakeToCamel(e)}`,{body:B(s)??null,method:"POST"}),catch:f=>new a({cause:{_tag:"ClientInternalError",cause:f}})}),c=yield*p.tryPromise({try:()=>o.json(),catch:()=>new a({cause:{_tag:"NotJsonResponse",response:o}})});return k(c)?o.ok?c.result:yield*p.fail(new a({cause:{_tag:"NotOkResponse",...c.error_code?{errorCode:c.error_code}:void 0,...c.description?{details:c.description}:void 0}})):yield*p.fail(new a({cause:{_tag:"UnexpectedResponse",response:c}}))});import*as i from"effect/Micro";var A=({fileId:e,type:s})=>b(e).pipe(i.andThen(({content:t,file_name:r})=>new File([t],r,{...s?{type:s}:void 0}))),Q=({fileId:e,type:s})=>b(e).pipe(i.andThen(({content:t,file_name:r})=>{let o=Buffer.from(t).toString("base64");return{encoded:`data:${s};base64,${o}`,file_name:r}})),b=e=>i.gen(function*(){let t=(yield*u("get_file",{file_id:e})).file_path;if(!t||t.length==0)return yield*i.fail(new a({cause:{_tag:"UnableToGetFile",cause:"File path not defined"}}));let r=t.replaceAll("/","-"),o=yield*i.service(m),c=yield*i.service(l),f=`${o}/file/bot${c}/${t}`;return{content:yield*i.tryPromise({try:()=>fetch(f).then(y=>y.arrayBuffer()),catch:y=>new a({cause:{_tag:"UnableToGetFile",cause:y}})}),file_name:r}});import*as n from"effect/Micro";import*as S from"effect/Context";import*as E from"effect/Micro";import*as h from"effect/Context";var d=class extends h.Tag("ClientFileService")(){},R=E.gen(function*(){return{getFile:A}});function re(e){return n.gen(function*(){let t=yield*n.service(d),r=S.make(l,e.bot_token);return{execute:(f,x)=>u(f,x).pipe(n.provideContext(r),n.runPromise),getFile:f=>t.getFile(f).pipe(n.provideContext(r),n.runPromise)}}).pipe(n.provideServiceEffect(d,R),n.runSync)}export{_ as MESSAGE_EFFECTS,F as TG_BOT_API_URL,m as TgBotApiBaseUrl,l as TgBotApiToken,a as TgBotClientError,u as executeTgBotMethod,A as getFile,Q as getFileAsBase64String,b as getFileBytes,T as isFileContent,v as isMessageEffect,k as isTgBotApiResponse,U as isTgBotApiUpdate,re as makeTgBotClient,P as messageEffectIdCodes};

package/dist/webapp.d.ts

@@ -1,392 +0,0 @@
-type BindOrUnbindEventHandler = <K extends keyof EventHandlers>(eventName: K, handler: EventHandlers[K]) => void;
-type EventHandlers = {
-    activated: () => void;
-    deactivated: () => void;
-    themeChanged: () => void;
-    viewportChanged: (options: {
-        isStateStable: boolean;
-    }) => void;
-    safeAreaChanged: () => void;
-    contentSafeAreaChanged: () => void;
-    mainButtonClicked: () => void;
-    backButtonClicked: () => void;
-    settingsButtonClicked: () => void;
-    invoiceClosed: (options: {
-        url: string;
-        status: "paid" | "cancelled" | "failed" | "pending";
-    }) => void;
-    popupClosed: (options: {
-        button_id: string | null;
-    }) => void;
-    qrTextReceived: (options: {
-        data: string;
-    }) => void;
-    scanQrPopupClosed: () => void;
-    clipboardTextReceived: (options: {
-        data: string;
-    }) => void;
-    writeAccessRequested: (options: {
-        status: "allowed" | "cancelled";
-    }) => void;
-    biometricManagerUpdated: () => void;
-    biometricAuthRequested: (options: {
-        isAuthenticated: boolean;
-        biometricToken: string | null;
-    }) => void;
-    biometricTokenUpdated: (options: {
-        isUpdated: boolean;
-    }) => void;
-    fullscreenChanged: () => void;
-    fullscreenFailed: (options: {
-        error: "UNSUPPORTED" | "ALREADY_FULLSCREEN";
-    }) => void;
-    homeScreenAdded: () => void;
-    homeScreenChecked: (options: {
-        status: "unsupported" | "unknown" | "added" | "missed";
-    }) => void;
-    accelerometerStarted: () => void;
-    accelerometerStopped: () => void;
-    accelerometerChanged: () => void;
-    accelerometerFailed: (options: {
-        error: "UNSUPPORTED";
-    }) => void;
-    deviceOrientationStarted: () => void;
-    deviceOrientationStopped: () => void;
-    deviceOrientationChanged: () => void;
-    deviceOrientationFailed: (options: {
-        error: "UNSUPPORTED";
-    }) => void;
-    gyroscopeStarted: () => void;
-    gyroscopeStopped: () => void;
-    gyroscopeChanged: () => void;
-    gyroscopeFailed: (options: {
-        error: "UNSUPPORTED";
-    }) => void;
-    locationManagerUpdated: () => void;
-    locationRequested: (options: {
-        locationData: LocationData;
-    }) => void;
-    shareMessageSent: () => void;
-    shareMessageFailed: (options: {
-        error: "UNSUPPORTED" | "MESSAGE_EXPIRED" | "MESSAGE_SEND_FAILED" | "USER_DECLINED" | "UNKNOWN_ERROR";
-    }) => void;
-    emojiStatusSet: () => void;
-    emojiStatusFailed: (options: {
-        error: "UNSUPPORTED" | "SUGGESTED_EMOJI_INVALID" | "DURATION_INVALID" | "USER_DECLINED" | "SERVER_ERROR" | "UNKNOWN_ERROR";
-    }) => void;
-    emojiStatusAccessRequested: (options: {
-        status: "allowed" | "cancelled";
-    }) => void;
-    fileDownloadRequested: (options: {
-        status: "downloading" | "cancelled";
-    }) => void;
-};
-
-interface WebApp {
-    initData: string;
-    initDataUnsafe: WebAppInitData;
-    version: string;
-    platform: string;
-    colorScheme: string;
-    themeParams: ThemeParams;
-    isActive: boolean;
-    isExpanded: boolean;
-    viewportHeight: number;
-    viewportStableHeight: number;
-    headerColor: string;
-    backgroundColor: string;
-    bottomBarColor: string;
-    isClosingConfirmationEnabled: boolean;
-    isVerticalSwipesEnabled: boolean;
-    isFullscreen: boolean;
-    isOrientationLocked: boolean;
-    safeAreaInset: SafeAreaInset;
-    contentSafeAreaInset: ContentSafeAreaInset;
-    BackButton: BackButton;
-    MainButton: BottomButton;
-    SecondaryButton: BottomButton;
-    SettingsButton: SettingsButton;
-    HapticFeedback: HapticFeedback;
-    CloudStorage: CloudStorage;
-    BiometricManager: BiometricManager;
-    Accelerometer: Accelerometer;
-    DeviceOrientation: DeviceOrientation;
-    Gyroscope: Gyroscope;
-    LocationManager: LocationManager;
-    DeviceStorage: DeviceStorage;
-    SecureStorage: SecureStorage;
-    isVersionAtLeast: (version: string) => boolean;
-    setHeaderColor: (color: string) => void;
-    setBackgroundColor: (color: string) => void;
-    setBottomBarColor: (color: string) => void;
-    enableClosingConfirmation: () => void;
-    disableClosingConfirmation: () => void;
-    enableVerticalSwipes: () => void;
-    disableVerticalSwipes: () => void;
-    requestFullscreen: () => void;
-    exitFullscreen: () => void;
-    lockOrientation: () => void;
-    unlockOrientation: () => void;
-    addToHomeScreen: () => void;
-    checkHomeScreenStatus: (callback?: (status: "unsupported" | "unknown" | "added" | "missed") => void) => void;
-    onEvent: BindOrUnbindEventHandler;
-    offEvent: BindOrUnbindEventHandler;
-    sendData: (data: string) => void;
-    switchInlineQuery: (query: string, chat_type?: "users" | "bots" | "groups" | "channels") => void;
-    openLink: (url: string, options?: {
-        try_instant_view: boolean;
-    }) => void;
-    openTelegramLink: (url: string) => void;
-    openInvoice: (url: string, callback?: (invoiceStatus: unknown) => void) => void;
-    shareToStory: (mediaUrl: string, options?: StoryShareParams) => void;
-    shareMessage: (msg_id: number, options?: (isSent: boolean) => void) => void;
-    setEmojiStatus: (custom_emoj_id: string, params?: EmojiStatusParams, callback?: (isStatusSet: boolean) => void) => void;
-    requestEmojiStatusAccess: (url: string, callback?: (invoiceStatus: unknown) => void) => void;
-    downloadFile: (params: DownloadFileParams, callback?: (isAccepted: boolean) => void) => void;
-    hideKeyboard: () => void;
-    showPopup: (params: PopupParams, callback?: (buttonId: string) => void) => void;
-    showAlert: (message: string, callback?: () => void) => void;
-    showConfirm: (message: string, callback?: (isOk: boolean) => void) => void;
-    showScanQrPopup: (params: ScanQrPopupParams, callback?: (data: string) => boolean) => void;
-    closeScanQrPopup: () => void;
-    readTextFromClipboard: (callback?: (text: string) => void) => void;
-    requestWriteAccess: (callback?: (isGranted: boolean) => void) => void;
-    requestContact: (callback?: (isShared: boolean) => void) => void;
-    ready: () => void;
-    expand: () => void;
-    close: () => void;
-}
-interface Accelerometer {
-    isStarted: boolean;
-    x: number;
-    y: number;
-    z: number;
-    start: (params: AccelerometerStartParams, callback?: (isStarted: boolean) => void) => Accelerometer;
-    stop: (callback?: (isStopped: boolean) => void) => Accelerometer;
-}
-interface AccelerometerStartParams {
-    refresh_rate?: number;
-}
-interface BackButton {
-    isVisible: boolean;
-    onClick: EventHandlers["backButtonClicked"];
-    offClick: EventHandlers["backButtonClicked"];
-    show: () => BackButton;
-    hide: () => BackButton;
-}
-interface BiometricAuthenticateParams {
-    reason?: string;
-}
-interface BiometricManager {
-    isInited: boolean;
-    isBiometricAvailable: boolean;
-    biometricType: "finger" | "face" | "unknown";
-    isAccessRequested: boolean;
-    isAccessGranted: boolean;
-    isBiometricTokenSaved: boolean;
-    deviceId: string;
-    init: (callback?: () => void) => BiometricManager;
-    requestAccess: (params: BiometricRequestAccessParams, callback?: (isGranted: boolean) => void) => BiometricManager;
-    authenticate: (params: BiometricAuthenticateParams, callback?: (isAuthenticated: boolean) => void) => BiometricManager;
-    updateBiometricToken: (token: string, callback?: (isTokenUpdated: boolean) => void) => BiometricManager;
-    openSettings: () => BiometricManager;
-}
-interface BiometricRequestAccessParams {
-    reason?: string;
-}
-interface BottomButton {
-    type: string;
-    text: string;
-    color: string;
-    textColor: string;
-    isVisible: boolean;
-    isActive: boolean;
-    hasShineEffect: boolean;
-    position: string;
-    isProgressVisible: boolean;
-    setText: (text: string) => BottomButton;
-    onClick: (callback: () => void) => BottomButton;
-    offClick: (callback: () => void) => BottomButton;
-    show: () => BottomButton;
-    hide: () => BottomButton;
-    enable: () => BottomButton;
-    disable: () => BottomButton;
-    showProgress: (callback: (leaveActive: boolean) => void) => BottomButton;
-    hideProgress: () => BottomButton;
-    setParams: (params: {
-        text: string;
-        color: string;
-        has_shine_effect: boolean;
-        position: unknown;
-        is_active: boolean;
-        is_visible: boolean;
-    }) => BottomButton;
-}
-interface CloudStorage {
-    setItem: (key: string, value: string, callback?: (error: unknown | null) => void) => CloudStorage;
-    getItem: (key: string, callback: (error: unknown | null, value: string | null) => void) => CloudStorage;
-    getItems: (keys: string[], callback: (error: string | null, values: Record<string, string> | null) => void) => CloudStorage;
-    removeItem: (key: string, callback?: (error: string | null, isDeleted: boolean) => void) => CloudStorage;
-    removeItems: (keys: string[], callback?: (error: string | null, isDeleted: boolean) => void) => CloudStorage;
-    getKeys: (callback: (error: string | null, keys: string[] | null) => void) => CloudStorage;
-}
-interface ContentSafeAreaInset {
-    top: number;
-    bottom: number;
-    left: number;
-    right: number;
-}
-interface DeviceOrientation {
-    isStarted: boolean;
-    absolute: boolean;
-    alpha: number;
-    beta: number;
-    gamma: number;
-    start: (params: DeviceOrientationStartParams, callback?: (isTracking: boolean) => void) => void;
-    stop: (callback?: (isStopped: boolean) => void) => void;
-}
-interface DeviceOrientationStartParams {
-    refresh_rate?: number;
-    need_absolute?: boolean;
-}
-interface DeviceStorage {
-    setItem: (key: string, value: string, callback?: (error: unknown | null, isStored: boolean) => void) => DeviceStorage;
-    getItem: (key: string, callback: (error: unknown | null, value: string | null) => void) => DeviceStorage;
-    removeItem: (key: string, callback?: (error: unknown | null, isRemoved: boolean) => void) => DeviceStorage;
-    clear: (callback?: (error: unknown | null, isCleared: boolean) => void) => DeviceStorage;
-}
-interface DownloadFileParams {
-    url: string;
-    file_name: string;
-}
-interface EmojiStatusParams {
-    duration?: number;
-}
-interface Gyroscope {
-    isStarted: boolean;
-    x: number;
-    y: number;
-    z: number;
-    start: (params: GyroscopeStartParams, callback?: (isTracking: boolean) => void) => void;
-    stop: (callback?: (isStopped: boolean) => void) => void;
-}
-interface GyroscopeStartParams {
-    refresh_rate?: number;
-}
-interface HapticFeedback {
-    impactOccurred: (style: "light" | "medium" | "heavy" | "rigid" | "soft") => void;
-    notificationOccurred: (type: "error" | "success" | "warning") => void;
-    selectionChanged: () => HapticFeedback;
-}
-interface LocationData {
-    latitude: number;
-    longitude: number;
-    altitude: number;
-    course: number;
-    speed: number;
-    horizontal_accuracy: number;
-    vertical_accuracy: number;
-    course_accuracy: number;
-    speed_accuracy: number;
-}
-interface LocationManager {
-    isInited: boolean;
-    isLocationAvailable: boolean;
-    isAccessRequested: boolean;
-    isAccessGranted: boolean;
-    init: (callback?: () => void) => LocationManager;
-    getLocation: (callback: (location: LocationData | null) => void) => LocationManager;
-    openSettings: () => LocationManager;
-}
-interface PopupButton {
-    id?: string;
-    type?: "OK" | "Close" | "Cancel";
-    text?: string;
-}
-interface PopupParams {
-    message: string;
-    title?: string;
-    buttons?: PopupButton[];
-}
-interface SafeAreaInset {
-    top: number;
-    bottom: number;
-    left: number;
-    right: number;
-}
-interface ScanQrPopupParams {
-    text?: string;
-}
-interface SecureStorage {
-    setItem: (key: string, value: string, callback?: (error: unknown | null, isStored: boolean) => void) => SecureStorage;
-    getItem: (key: string, callback: (error: unknown | null, value: string | null, canBeRestored: boolean) => void) => SecureStorage;
-    restoreItem: (key: string, callback?: (error: unknown | null, value: string | null) => void) => SecureStorage;
-    removeItem: (key: string, callback?: (error: unknown | null, isRemoved: boolean) => void) => SecureStorage;
-    clear: (callback?: (error: unknown | null, isCleared: boolean) => void) => SecureStorage;
-}
-interface SettingsButton {
-    isVisible: boolean;
-    onClick: (callback: () => void) => SettingsButton;
-    offClick: (callback: () => void) => SettingsButton;
-    show: () => SettingsButton;
-    hide: () => SettingsButton;
-}
-interface StoryShareParams {
-    text?: string;
-    widget_link?: StoryWidgetLink;
-}
-interface StoryWidgetLink {
-    url: string;
-    name?: string;
-}
-interface ThemeParams {
-    bg_color?: string;
-    text_color?: string;
-    hint_color?: string;
-    link_color?: string;
-    button_color?: string;
-    button_text_color?: string;
-    secondary_bg_color?: string;
-    header_bg_color?: string;
-    bottom_bar_bg_color?: string;
-    accent_text_color?: string;
-    section_bg_color?: string;
-    section_header_text_color?: string;
-    section_separator_color?: string;
-    subtitle_text_color?: string;
-    destructive_text_color?: string;
-}
-interface WebAppChat {
-    id: number;
-    type: "group" | "supergroup" | "channel";
-    title: string;
-    username?: string;
-    photo_url?: "in";
-}
-interface WebAppInitData {
-    auth_date: number;
-    hash: string;
-    signature: string;
-    query_id?: string;
-    user?: WebAppUser;
-    receiver?: WebAppUser;
-    chat?: WebAppChat;
-    chat_type?: string;
-    chat_instance?: string;
-    start_param?: string;
-    can_send_after?: number;
-}
-interface WebAppUser {
-    id: number;
-    first_name: string;
-    is_bot?: boolean;
-    last_name?: string;
-    username?: string;
-    language_code?: string;
-    is_premium?: boolean;
-    added_to_attachment_menu?: boolean;
-    allows_write_to_pm?: boolean;
-    photo_url?: "in";
-}
-
-export type { Accelerometer, AccelerometerStartParams, BackButton, BiometricAuthenticateParams, BiometricManager, BiometricRequestAccessParams, BottomButton, CloudStorage, ContentSafeAreaInset, DeviceOrientation, DeviceOrientationStartParams, DeviceStorage, DownloadFileParams, EmojiStatusParams, Gyroscope, GyroscopeStartParams, HapticFeedback, LocationData, LocationManager, PopupButton, PopupParams, SafeAreaInset, ScanQrPopupParams, SecureStorage, SettingsButton, StoryShareParams, StoryWidgetLink, ThemeParams, WebApp, WebAppChat, WebAppInitData, WebAppUser };

package/dist/webapp.js

@@ -1 +0,0 @@
-"use strict";var m=Object.defineProperty;var t=Object.getOwnPropertyDescriptor;var x=Object.getOwnPropertyNames;var a=Object.prototype.hasOwnProperty;var b=(r,o,p,f)=>{if(o&&typeof o=="object"||typeof o=="function")for(let e of x(o))!a.call(r,e)&&e!==p&&m(r,e,{get:()=>o[e],enumerable:!(f=t(o,e))||f.enumerable});return r};var c=r=>b(m({},"__esModule",{value:!0}),r);var d={};module.exports=c(d);

package/readme.md

@@ -1,236 +0,0 @@
-[![NPM Version](https://img.shields.io/npm/v/%40effect-ak%2Ftg-bot-client)](https://www.npmjs.com/package/@effect-ak/tg-bot-client)
-![Telegram Bot API](https://img.shields.io/badge/BotApi-9.1-blue?link=)
-![Telegram WebApp](https://img.shields.io/badge/Telegram.WebApp-9.1-blue?link=)
-[![OpenAPI](https://img.shields.io/badge/OpenAPI-3.1-blue.svg)](https://effect-ak.github.io/telegram-bot-api/)
-![NPM Unpacked Size](https://img.shields.io/npm/unpacked-size/%40effect-ak%2Ftg-bot-client?link=)
-![NPM Downloads](https://img.shields.io/npm/dw/%40effect-ak%2Ftg-bot-client?link=)
-
-## Motivation
-**Telegram** does not offer an official TypeScript **SDK** for their **API** but they provide documentation in HTML format.
-
-This package aims to parse official documentation of [Bot Api](https://core.telegram.org/bots/api) and [Telegram.Webapp](https://core.telegram.org/bots/api)  and generate **TypeScript types**!
-
-## Highlights:
-- **[Client](#client)**: Light TypeScript client
-- **Complete and Up-to-Date Telegram Bot API**: The entire API is generated from [the official documentation](https://core.telegram.org/bots/api) using a [code generator](./codegen/main.ts), ensuring this client remains in sync and supports every method and type provided by the **Telegram Bot API**.
-- **[Types for Webapps](#webapps-typings)** Types that describe `Telegram.WebApp`. Created by [code generator](./codegen/main.ts) as well.
-- **[ChatBot runner](#chatbot-runner)**: Focus on the logic of your chat bot
-- **Type Mapping**: Types from the documentation are converted to TypeScript types:
-  - `Integer` → `number`
-  - `True` → `boolean`
-  - `String or Number` → `string | number`
-  - Enumerated types, such as `"Type of the chat can be either “private”, “group”, “supergroup” or “channel”"`, are converted to a standard union of literal types `"private" | "group" | "supergroup" | "channel"`
-  - And more...
-
-## Client
-
-```typescript
-import { makeTgBotClient } from "@effect-ak/tg-bot-client"
-
-const client = makeTgBotClient({
-  bot_token: "" //your token taken from bot father
-});
-```
-
-### Executing api methods (Promise based)
-
-`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`
-
-> Method names, such as `setChatAdministratorCustomTitle`, are converted to snake_case for easier code readability, e.g., `set_chat_administrator_custom_title`.
-
-#### 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
-import { MESSAGE_EFFECTS } from "@effect-ak/tg-bot-client"
-
-await client.execute("send_dice", {
-  chat_id: "???", // replace ??? with the chat number
-  emoji: "🎲"
-});
-```
-
-#### 3. Sending a Document
-
-```typescript
-import { MESSAGE_EFFECTS } from "@effect-ak/tg-bot-client"
-
-await client.execute("send_document", {
-  chat_id: "???", // replace ??? with the chat number
-  message_effect_id: MESSAGE_EFFECTS["🎉"],
-  document: {
-    file_content: new TextEncoder().encode("Hello!"),
-    file_name: "hello.txt"
-  },
-  caption: "simple text file"
-})
-```
-
-
-#### 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
-  });
-```
-
-### Executing api methods (Effect based)
-
-If you want to use [Effect](https://effect.website/) instead of `Promise`:
-```typescript
-import { executeTgBotMethod, TgBotApiToken } from "@effect-ak/tg-bot-client";
-import { Effect } from "effect";
-
-executeTgBotMethod("send_message", {
-  text: "hello",
-  chat_id: config.chat_id
-}).pipe(
-  Effect.provideService(TgBotApiToken, 'your-token-from-bot-father'),
-  Effect.runPromiseExit
-)
-```
-
-## ChatBot runner
-
-### How this library helps
-
-A chatbot is essentially a **function** that is triggered by every user message, whether it's a text message, a reaction, or a payment update. Lets name this function as **handler function**
-
-This library handles the task of reading these **updates** from the Telegram Bot API's **message queue**. It then invokes the appropriate **handler function** with the received update.
-
-### Playground
-
-Develop/Run chat bots in your browser via **[Chat Bot Playground](https://effect-ak.github.io/telegram-bot-playground/)**
-
-### Local run
-
-You can write the logic for your chatbot and **run it locally** and message to your bot via **Telegram** messenger.
-
-Take a look at examples [here](example)
-
-### Setup Instructions
-
-1. **Create `bot.js` and Implement Your Bot's Logic**
-
-   Create a file (for example `bot.js`) and add your bot's logic as shown below:
-
-   ```typescript
-   import { MESSAGE_EFFECTS } from "@effect-ak/tg-bot-client"
-   import { runTgChatBot, BotResponse, defineBot } from "@effect-ak/tg-bot-client/bot"
-
-   const BOT = defineBot({
-      on_message: (msg) => {
-
-      if (!msg.text) return BotResponse.ignore;
-
-      if (msg?.text === "bye") {
-        return BotResponse.make({
-          type: "message",
-          text: "See you later!",
-          message_effect_id: MESSAGE_EFFECTS["❤️"]
-        })
-      }
-
-      return BotResponse.make({
-        type: "message",
-        text: "I'm a simple bot"
-      })
-     }
-   })
-
-   runTgChatBot({
-     bot_token: "your-token" // PUT YOUR TOKEN HERE
-     mode: {
-      type: "single",
-      ...BOT
-     }
-   })
-   ```
-
-2. **Run the Bot**
-
-   To start your chatbot, execute the following command in your terminal:
-
-   ```bash
-   node bot.js
-   ```
-
-### How It Works: Pull Model
-
-The Telegram bot supports both **push** and **pull** notification models for messages. This package uses the **pull** model for several reasons:
-
-- **Run chat bots anywhere without exposing public ports or URLs:** The Telegram **push** model requires you as a developer to specify a public URL where updates will be sent.  
-  For example, **pull** allows running chat bots in a web browser, which doesn't have a public URL.
-  
-- **Leveraging Telegram's infrastructure:** Telegram keeps new updates for 24 hours and gives you plenty of time to process them.
-
-#### Few details and clarifications
-
-Developer is responsible only for **Handler Function**.
-
-**ChatBot runner** reads updates from the  queue and shifts **ID** of last proceeded update so that **handler function** won't be triggered multiple times for the same update.
-
-```mermaid
-graph TD
-  HandlerFunction[/**Handler Function**/]
-  Library[**ChatBot runner**]
-  TgBot[Telegram chat bot]
-  MessageQueue[**Bot updates queue**<br>_api.telegram.org/bot/updates_]
-  User -->|Sends Update, e.g  a text message| TgBot
-  TgBot -->|Stores Update for 24 hours | MessageQueue
-
-  subgraph Pull Updates
-    Library -->|Fetches Update | MessageQueue
-    Library -->|Invokes| HandlerFunction
-  end
-
-
-```
-
-## Webapps typings
-
-Telegram provides a big [html](https://core.telegram.org/bots/webapps) page that describes `Telegram.WebApp`
-
-`@effect-ak/tg-bot-client` leverages scrapper's functionality to generate TypeScript types.
-
-```typescript
-import type { WebApp } from "@effect-ak/tg-bot-client/webapp";
-
-interface Telegram {
-  WebApp: TgWebApp
-}
-
-declare const Telegram: Telegram;
-
-const saveData = () => {
-
-  Telegram.WebApp.CloudStorage.setItem("key1", "some data", (error) => {
-    if (error == null) {
-      console.log("Saved!")
-    }
-  })
-
-}
-```