@aracna/telegram-bot 2.0.3 → 2.0.5

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2022 Dario Sechi
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2022 Dario Sechi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,18 +1,18 @@
-![NPM](https://img.shields.io/npm/l/@aracna/telegram-bot)
-![npm (scoped)](https://img.shields.io/npm/v/@aracna/telegram-bot)
-[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=aracna_telegram-bot&metric=coverage)](https://sonarcloud.io/summary/new_code?id=aracna_telegram-bot)
-[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=aracna_telegram-bot&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=aracna_telegram-bot)
-[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=aracna_telegram-bot&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=aracna_telegram-bot)
-[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=aracna_telegram-bot&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=aracna_telegram-bot)
-[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=aracna_telegram-bot&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=aracna_telegram-bot)
-[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=aracna_telegram-bot&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=aracna_telegram-bot)
-[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=aracna_telegram-bot&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=aracna_telegram-bot)
-[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=aracna_telegram-bot&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=aracna_telegram-bot)
-
-# Aracna Telegram Bot
-
-This library makes building Telegram Bot back-ends a breeze by abstracting all the tedious parts and exposing a simple API to work with.
-
-### Documentation
-
-You can find the telegram bot documentation on the [Aracna Website](https://aracna.dariosechi.it).
+![NPM](https://img.shields.io/npm/l/@aracna/telegram-bot)
+![npm (scoped)](https://img.shields.io/npm/v/@aracna/telegram-bot)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=aracna_telegram-bot&metric=coverage)](https://sonarcloud.io/summary/new_code?id=aracna_telegram-bot)
+[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=aracna_telegram-bot&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=aracna_telegram-bot)
+[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=aracna_telegram-bot&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=aracna_telegram-bot)
+[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=aracna_telegram-bot&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=aracna_telegram-bot)
+[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=aracna_telegram-bot&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=aracna_telegram-bot)
+[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=aracna_telegram-bot&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=aracna_telegram-bot)
+[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=aracna_telegram-bot&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=aracna_telegram-bot)
+[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=aracna_telegram-bot&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=aracna_telegram-bot)
+
+# Aracna Telegram Bot
+
+This library makes building Telegram Bot back-ends a breeze by abstracting all the tedious parts and exposing a simple API to work with.
+
+### Documentation
+
+You can find the telegram bot documentation on the [Aracna Website](https://aracna.dariosechi.it).

package/apis/telegram-api.d.ts

@@ -1,9 +1,11 @@
-import { type FetchError, Queue, type RequestMethod, RestAPI } from '@aracna/core';
-import { TelegramApiDefinitions } from '../definitions/telegram-api-definitions';
-declare class API extends RestAPI<TelegramApiDefinitions.Config> {
+import { FetchError, Queue, type RequestMethod, RestAPI } from '@aracna/core';
+import { TelegramApiConfig } from '../definitions/interfaces';
+declare class API extends RestAPI<TelegramApiConfig> {
     queue: Queue;
-    post<V, W, X = undefined>(path: string, body: W | undefined, config: TelegramApiDefinitions.Config): Promise<V | FetchError<X>>;
-    transformBody<V>(method: RequestMethod, path: string, body: V, config: TelegramApiDefinitions.Config): Promise<V | FormData | undefined>;
+    post<V, W, X = undefined>(path: string, body: W | undefined, config?: TelegramApiConfig): Promise<V | FetchError<X>>;
+    transformBody<V>(method: RequestMethod, path: string, body: V, config: TelegramApiConfig): Promise<V | FormData | undefined>;
+    getToken(): string | undefined;
+    setToken(token?: string): this;
 }
 export declare const TelegramAPI: API;
 export {};

package/apis/telegram-api.js

@@ -5,11 +5,14 @@ const core_1 = require("@aracna/core");
 class API extends core_1.RestAPI {
     queue = new core_1.Queue({ autostart: true });
     async post(path, body, config) {
-        let fn, callback, promise;
+        let token, promise, fn, callback;
+        token = config?.token ?? this.config?.token;
+        if (!token)
+            return core_1.FetchError.from(new Error(`The token is required.`));
         promise = new core_1.DeferredPromise();
         fn = async () => {
             let response;
-            response = await super.post('/bot' + config.token + '/' + path, body, config);
+            response = await super.post('/bot' + token + '/' + path, body, config);
             if (response instanceof Error)
                 return response;
             return response.data.result;
@@ -38,6 +41,13 @@ class API extends core_1.RestAPI {
         }
         return body;
     }
+    getToken() {
+        return this.config.token;
+    }
+    setToken(token) {
+        this.config.token = token;
+        return this;
+    }
 }
 exports.TelegramAPI = new API('https://api.telegram.org', {
     decode: {
@@ -50,6 +60,5 @@ exports.TelegramAPI = new API('https://api.telegram.org', {
         json: {
             castBigIntToString: true
         }
-    },
-    token: undefined
+    }
 });

package/apis/telegram-file-api.d.ts

@@ -1,7 +1,9 @@
-import { type FetchError, RestAPI } from '@aracna/core';
-import { TelegramApiDefinitions } from '../definitions/telegram-api-definitions';
-declare class API extends RestAPI<TelegramApiDefinitions.Config> {
-    get<V, W = undefined>(path: string, config: TelegramApiDefinitions.Config): Promise<V | FetchError<W>>;
+import { FetchError, RestAPI } from '@aracna/core';
+import type { TelegramFileApiConfig } from '../definitions/interfaces';
+declare class API extends RestAPI<TelegramFileApiConfig> {
+    get<V, W = undefined>(path: string, config?: TelegramFileApiConfig): Promise<V | FetchError<W>>;
+    getToken(): string | undefined;
+    setToken(token?: string): this;
 }
 export declare const TelegramFileAPI: API;
 export {};

package/apis/telegram-file-api.js

@@ -4,11 +4,21 @@ exports.TelegramFileAPI = void 0;
 const core_1 = require("@aracna/core");
 class API extends core_1.RestAPI {
     async get(path, config) {
-        let response;
-        response = await super.get('/file/bot' + config.token + '/' + path, config);
+        let token, response;
+        token = config?.token ?? this.config?.token;
+        if (!token)
+            return core_1.FetchError.from(new Error(`The token is required.`));
+        response = await super.get('/file/bot' + token + '/' + path, config);
         if (response instanceof Error)
             return response;
         return response.data;
     }
+    getToken() {
+        return this.config.token;
+    }
+    setToken(token) {
+        this.config.token = token;
+        return this;
+    }
 }
 exports.TelegramFileAPI = new API('https://api.telegram.org');

package/classes/client.js

@@ -32,11 +32,11 @@ class Client {
                 if (!options?.webhook?.url) {
                     return new Error(`The webhook URL is required.`);
                 }
-                del = await (0, webhook_requests_1.deleteWebhook)(this.token, options.webhook.delete);
+                del = await (0, webhook_requests_1.deleteWebhook)(options.webhook.delete, { token: this.token });
                 if (del instanceof Error)
                     return del;
                 class_logger_1.ClassLogger.verbose('Telegram', 'connect', `The webhook has been deleted.`);
-                set = await (0, webhook_requests_1.setWebhook)(this.token, options.webhook);
+                set = await (0, webhook_requests_1.setWebhook)(options.webhook, { token: this.token });
                 if (set instanceof Error)
                     return set;
                 class_logger_1.ClassLogger.info('Telegram', 'connect', `The webhook has been set.`);
@@ -49,7 +49,7 @@ class Client {
         class_logger_1.ClassLogger.verbose('Telegram', 'disconnect', `The offset has been reset.`, [this.offset]);
         (0, core_1.clearInterval)(this.id);
         class_logger_1.ClassLogger.info('Telegram', 'disconnect', `The client has been disconnected.`);
-        await (0, webhook_requests_1.deleteWebhook)(this.token, options?.webhook);
+        await (0, webhook_requests_1.deleteWebhook)(options?.webhook, { token: this.token });
         class_logger_1.ClassLogger.info('Telegram', 'disconnect', `The webhook has been deleted.`);
     }
     on(type, middleware, options) {
@@ -180,7 +180,7 @@ class Client {
             return;
         listener.middleware(query);
         if (listener.options.deleteOnCallbackQuery && query.message) {
-            (0, delete_requests_1.deleteMessage)(this.token, { chat_id: body.c ? query.from.id : query.message.chat.id, message_id: query.message.message_id });
+            (0, delete_requests_1.deleteMessage)({ chat_id: body.c ? query.from.id : query.message.chat.id, message_id: query.message.message_id }, { token: this.token });
         }
         return listener;
     }
@@ -337,7 +337,7 @@ class Client {
             return;
         listener.middleware(reply);
         if (listener.id.length > 0 && listener.options.deleteOnReply && reply.from && reply.reply_to_message) {
-            (0, delete_requests_1.deleteMessages)(this.token, { chat_id: reply.from.id, message_ids: [reply.message_id, reply.reply_to_message.message_id] });
+            (0, delete_requests_1.deleteMessages)({ chat_id: reply.from.id, message_ids: [reply.message_id, reply.reply_to_message.message_id] }, { token: this.token });
         }
         return listener;
     }
@@ -358,7 +358,7 @@ class Client {
             return;
         listener.middleware(start);
         if (listener.id.length > 0 && listener.options.deleteOnMessageStart) {
-            (0, delete_requests_1.deleteMessage)(this.token, { chat_id: body.c ? start.from?.id ?? 0n : start.chat.id, message_id: start.message_id });
+            (0, delete_requests_1.deleteMessage)({ chat_id: body.c ? start.from?.id ?? 0n : start.chat.id, message_id: start.message_id }, { token: this.token });
         }
         return listener;
     }
@@ -370,7 +370,7 @@ class Client {
             offset: options?.offset ?? this.offset,
             timeout: options?.timeout
         };
-        updates = await (0, get_requests_1.getUpdates)(this.token, body);
+        updates = await (0, get_requests_1.getUpdates)(body, { token: this.token });
         if (updates instanceof Error)
             return;
         for (let update of updates) {

package/definitions/interfaces.d.ts

@@ -1,3 +1,4 @@
+import type { FetchResponse, RestApiConfig } from '@aracna/core';
 import type { BusinessConnection, BusinessMessagesDeleted, ChatBoostRemoved, ChatBoostUpdated, ChatJoinRequest, ChatMemberUpdated, ChosenInlineResult, DeleteWebhook, EditMessageMedia, GetUpdates, InlineQuery, InputMediaAudio, InputMediaDocument, InputMediaPhoto, InputMediaVideo, Message, MessageReactionCountUpdated, MessageReactionUpdated, CallbackQuery as NativeCallbackQuery, Poll, PollAnswer, PreCheckoutQuery, SendMediaGroup, SendMessage, SendPaidMedia, SetWebhook, ShippingQuery } from '@aracna/telegram-bot-types';
 import type { ClientListenerMiddleware, InputFile, UpdateType } from './types';
 export interface CallbackQuery<T = any> extends NativeCallbackQuery {
@@ -114,3 +115,14 @@ export interface StartBody<T = any> {
     d?: T;
     m?: string;
 }
+export interface TelegramApiConfig extends RestApiConfig {
+    token?: string;
+}
+export interface TelegramApiResponse<T> extends FetchResponse<TelegramApiResponseData<T>> {
+}
+export interface TelegramApiResponseData<T> {
+    ok: boolean;
+    result: T;
+}
+export interface TelegramFileApiConfig extends TelegramApiConfig {
+}