@mtkruto/node 0.0.992 → 0.0.994

package/script/client/3_types.d.ts

@@ -0,0 +1,221 @@
+import { MaybePromise } from "../1_utilities.js";
+import { CallbackQuery, ForceReply, InlineKeyboardMarkup, InlineQuery, Message, MessageEntity, ReplyKeyboardMarkup, ReplyKeyboardRemove } from "../3_types.js";
+import { With } from "./0_utilities.js";
+import { ClientPlainParams } from "./2_client_plain.js";
+export type ParseMode = "html" | "none";
+export interface ClientParams extends ClientPlainParams {
+    /**
+     * A parse mode to use when the `parseMode` parameter is not specified when sending or editing messages. Defauls to `ParseMode.None`.
+     */
+    parseMode?: ParseMode;
+    /**
+     * The app_version parameter to be passed to initConnection when calling `authorize`. It is recommended that this parameter is changed if users are authorized. Defaults to "MTKruto" followed by this version of MTKruto.
+     */
+    appVersion?: string;
+    /**
+     * The device_version parameter to be passed to initConnection when calling `authorize`. The default varies by the current runtime.
+     */
+    deviceModel?: string;
+    /**
+     * The lang_code parameter to be passed to initConnection when calling `authorize`. Defaults to the runtime's language or `"en"`.
+     */
+    langCode?: string;
+    /**
+     * The lang_pack parameter to be passed to initConnection when calling `authorize`. Defaults to an empty string.
+     */
+    langPack?: string;
+    /**
+     * The system_lang_cde parameter to be passed to initConnection when calling `authorize`. Defaults to the runtime's language or `"en"`.
+     */
+    systemLangCode?: string;
+    /**
+     * The system_version parameter to be passed to initConnection when calling `authorize`. The default varies by the current runtime.
+     */
+    systemVersion?: string;
+    /**
+     * Whether to automatically call `start` with no parameters in the first `invoke` call. Defaults to `true`.
+     */
+    autoStart?: boolean;
+}
+export interface AnswerCallbackQueryParams {
+    /** Text of the answer */
+    text?: string;
+    /** Pass true to show an alert to the user instead of a toast notification */
+    alert?: boolean;
+    /** URL to be opened */
+    url?: string;
+    /** Time during which the result of the query can be cached, in seconds */
+    cacheTime?: number;
+}
+export interface AuthorizeUserParams<S = string> {
+    phone: S | (() => MaybePromise<S>);
+    code: S | (() => MaybePromise<S>);
+    password: S | ((hint: string | null) => MaybePromise<S>);
+}
+/**
+ * A chat identifier as provided by MTKruto or a string starting with a @ that is followed by a username.
+ */
+export type ChatID = number | string;
+export interface SendMessagesParams {
+    /**
+     * The parse mode to use. If not provided, the default parse mode will be used.
+     */
+    parseMode?: ParseMode;
+    /**
+     * The message's entities.
+     */
+    entities?: MessageEntity[];
+    /**
+     * Whether to disable web page previews in the message that is to be sent.
+     */
+    disableWebPagePreview?: boolean;
+    /**
+     * Whether to send the message in a silent way without making a sound on the recipients' clients.
+     */
+    disableNotification?: boolean;
+    /**
+     * Whether to protect the contents of the message from copying and forwarding.
+     */
+    protectContent?: boolean;
+    /**
+     * The identifier of a message to reply to.
+     */
+    replyToMessageId?: number;
+    /**
+     * The identifier of a thread to send the message to.
+     */
+    messageThreadId?: number;
+    /**
+     * The identifier of the chat to send the message on behalf of. User-only.
+     */
+    sendAs?: ChatID;
+    /**
+     * The reply markup of the message. Bot-only.
+     */
+    replyMarkup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
+}
+export interface EditMessageParams {
+    /**
+     * The parse mode to use. If not provided, the default parse mode will be used.
+     */
+    parseMode?: ParseMode;
+    /**
+     * The message's entities.
+     */
+    entities?: MessageEntity[];
+    /**
+     * Whether to disable web page previews in the message that is to be edited.
+     */
+    disableWebPagePreview?: boolean;
+    /**
+     * The reply markup of the message. Bot-only.
+     */
+    replyMarkup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
+}
+export interface ForwardMessagesParams {
+    messageThreadId?: number;
+    /**
+     * Whether to forward the message in a silent way without making a sound on the recipients' clients.
+     */
+    disableNotification?: boolean;
+    /**
+     * Whether to protect the contents of the forwarded message from copying and forwarding.
+     */
+    protectContent?: boolean;
+    /**
+     * The identifier of the chat to forward the message on behalf of. User-only.
+     */
+    sendAs?: ChatID;
+    /**
+     * Whether to not include the original sender of the message that is going to be forwarded.
+     */
+    dropSenderName?: boolean;
+    /**
+     * Whether to not include the original caption of the message that is going to be forwarded.
+     */
+    dropCaption?: boolean;
+}
+export interface SendPollParams {
+    /**
+     * True, if the poll needs to be anonymous, defaults to True */
+    isAnonymous?: boolean;
+    /**
+     * The type of the poll. Defaults to regular. */
+    type?: "quiz" | "regular";
+    /**
+     * True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False */
+    allowMultipleAnswers?: boolean;
+    /**
+     * Index of the correct option. Required for quizzes. */
+    correctOptionIndex?: number;
+    /**
+     *  Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters with at most 2 line feeds after entities parsing */
+    explanation?: string;
+    /**
+     * The parse mode to use for the explanation. If not provided, the default parse mode will be used.
+     */
+    explanationParseMode?: ParseMode;
+    /**
+     * The explanation's entities.
+     */
+    explanationEntities?: MessageEntity[];
+    /**
+     * Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with close_date.
+     */
+    openPeriod?: number;
+    /**
+     * Point in time when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future. Can't be used together with open_period.
+     */
+    closeDate?: Date;
+    /**
+     * Pass True if the poll needs to be immediately closed. This can be useful for poll preview.
+     */
+    isClosed?: boolean;
+    /**
+     * Whether to send the message in a silent way without making a sound on the recipients' clients.
+     */
+    disableNotification?: boolean;
+    /**
+     * The identifier of a message to reply to.
+     */
+    replyToMessageId?: number;
+    /**
+     * The identifier of a thread to send the message to.
+     */
+    messageThreadId?: number;
+    /**
+     * The identifier of the chat to send the message on behalf of. User-only.
+     */
+    sendAs?: ChatID;
+    /**
+     * The reply markup of the message. Bot-only.
+     */
+    replyMarkup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
+    /**
+     * Whether to protect the contents of the message from copying and forwarding.
+     */
+    protectContent?: boolean;
+}
+export type ConnectionState = "not-connected" | "updating" | "ready";
+export type AuthorizationState = {
+    authorized: boolean;
+};
+export type FilterableUpdates = "message" | "editedMessage" | "callbackQuery";
+export interface Update {
+    message?: Message;
+    editedMessage?: Message;
+    connectionState?: ConnectionState;
+    authorizationState?: AuthorizationState;
+    deletedMessages?: [Message, ...Message[]];
+    callbackQuery?: CallbackQuery;
+    inlineQuery?: InlineQuery;
+}
+export type NextFn = () => Promise<void>;
+export interface HandlerObj<U extends Partial<Update> = Partial<Update>> {
+    handle(update: U, next: NextFn): MaybePromise<void>;
+}
+export type HandlerFn<U extends Partial<Update> = Partial<Update>> = HandlerObj<U>["handle"];
+export type Handler<U extends Partial<Update> = Partial<Update>> = HandlerObj<U> | HandlerFn<U>;
+export type FilterUpdate<U extends Update, T extends keyof U, F extends keyof NonNullable<U[T]>> = With<U, T> & Pick<{
+    [P in T]-?: With<NonNullable<U[T]>, F>;
+}, T>;

package/script/client/3_types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/script/client/4_composer.d.ts

@@ -0,0 +1,13 @@
+import { MaybePromise } from "../1_utilities.js";
+import { FilterableUpdates, FilterUpdate, Handler, HandlerFn, HandlerObj, Update } from "./3_types.js";
+export declare function call(handler: Handler): HandlerFn;
+export declare class Composer<U extends Update = Update> implements HandlerObj<U> {
+    constructor(...handlers: Handler<U>[]);
+    get handle(): HandlerFn;
+    private _handle;
+    use(...handlers: Handler<U>[]): this;
+    branch(predicate: (upd: U) => MaybePromise<boolean>, trueHandler: Handler<U>, falseHandler: Handler<U>): this;
+    filter<D extends U>(predicate: (ctx: U) => ctx is D, ...middleware: Handler<D>[]): Composer<D>;
+    filter(predicate: (ctx: U) => MaybePromise<boolean>, ...middleware: Handler<U>[]): Composer<U>;
+    on<T extends keyof U, F extends keyof NonNullable<U[T]>>(filter: T extends FilterableUpdates ? T | [T, F, ...F[]] : T, ...handlers: Handler<FilterUpdate<U, T, F>>[]): Composer<FilterUpdate<U, T, F>>;
+}

package/script/client/4_composer.js

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Composer = exports.call = void 0;
+const _0_utilities_js_1 = require("./0_utilities.js");
+function call(handler) {
+    if ("handle" in handler) {
+        return handler.handle;
+    }
+    else {
+        return handler;
+    }
+}
+exports.call = call;
+function concat(what, with_) {
+    return async (upd, next) => {
+        let called = false;
+        await call(what)(upd, async () => {
+            if (called)
+                return;
+            called = true;
+            await call(with_)(upd, next);
+        });
+    };
+}
+function reduce(...handlers) {
+    return handlers.reduce((a, b) => concat(a, b));
+}
+class Composer {
+    constructor(...handlers) {
+        Object.defineProperty(this, "_handle", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: _0_utilities_js_1.resolve
+        });
+        this.use(...handlers);
+    }
+    get handle() {
+        return this._handle;
+    }
+    use(...handlers) {
+        const handle = this.handle;
+        this._handle = concat(handle, reduce(...handlers));
+        return this;
+    }
+    branch(predicate, trueHandler, falseHandler) {
+        return this.use(async (upd, next) => {
+            if (await predicate(upd)) {
+                await call(trueHandler)(upd, next);
+            }
+            else {
+                await call(falseHandler)(upd, next);
+            }
+        });
+    }
+    filter(predicate, ...middleware) {
+        const composer = new Composer(...middleware);
+        this.branch(predicate, composer, _0_utilities_js_1.resolve);
+        return composer;
+    }
+    on(filter, ...handlers) {
+        // deno-lint-ignore ban-ts-comment
+        // @ts-ignore
+        const type = typeof filter === "string" ? filter : filter[0];
+        const keys = Array.isArray(filter) ? filter.slice(1) : [];
+        return this.filter((update) => {
+            if (type in update) {
+                if (keys.length > 0) {
+                    for (const key of keys) {
+                        // deno-lint-ignore ban-ts-comment
+                        // @ts-ignore
+                        if (!(key in update[type])) {
+                            return false;
+                        }
+                    }
+                }
+                return true;
+            }
+            else {
+                return false;
+            }
+        }, ...handlers);
+    }
+}
+exports.Composer = Composer;

package/script/client/{3_client.d.ts → 5_client.d.ts}

@@ -1,152 +1,15 @@
-import { MaybePromise } from "../1_utilities.js";
 import { functions, ReadObject, types } from "../2_tl.js";
 import { Storage } from "../3_storage.js";
 import { DC } from "../3_transport.js";
-import { CallbackQuery, ForceReply, InlineKeyboardMarkup, InlineQuery, Message, // high-level Telegram API message
-MessageEntity, ReplyKeyboardMarkup, ReplyKeyboardRemove } from "../3_types.js";
-import { ClientPlainParams } from "./2_client_plain.js";
+import { Message } from "../3_types.js";
+import { With } from "./0_utilities.js";
 import { ClientAbstract } from "./1_client_abstract.js";
+import { AnswerCallbackQueryParams, AuthorizeUserParams, ChatID, ClientParams, EditMessageParams, ForwardMessagesParams, Handler, ParseMode, SendMessagesParams, SendPollParams } from "./3_types.js";
 export declare const getEntity: unique symbol;
 export declare const getStickerSetName: unique symbol;
 export declare const handleMigrationError: unique symbol;
 export declare const getMessageWithReply: unique symbol;
 export declare const restartAuth: unique symbol;
-export declare enum ParseMode {
-    None = "none",
-    HTML = "html"
-}
-export interface AuthorizeUserParams<S = string> {
-    phone: S | (() => MaybePromise<S>);
-    code: S | (() => MaybePromise<S>);
-    password: S | ((hint: string | null) => MaybePromise<S>);
-}
-export interface ClientParams extends ClientPlainParams {
-    /**
-     * A parse mode to use when the `parseMode` parameter is not specified when sending or editing messages. Defauls to `ParseMode.None`.
-     */
-    parseMode?: ParseMode;
-    /**
-     * The app_version parameter to be passed to initConnection when calling `authorize`. It is recommended that this parameter is changed if users are authorized. Defaults to "MTKruto" followed by this version of MTKruto.
-     */
-    appVersion?: string;
-    /**
-     * The device_version parameter to be passed to initConnection when calling `authorize`. The default varies by the current runtime.
-     */
-    deviceModel?: string;
-    /**
-     * The lang_code parameter to be passed to initConnection when calling `authorize`. Defaults to the runtime's language or `"en"`.
-     */
-    langCode?: string;
-    /**
-     * The lang_pack parameter to be passed to initConnection when calling `authorize`. Defaults to an empty string.
-     */
-    langPack?: string;
-    /**
-     * The system_lang_cde parameter to be passed to initConnection when calling `authorize`. Defaults to the runtime's language or `"en"`.
-     */
-    systemLangCode?: string;
-    /**
-     * The system_version parameter to be passed to initConnection when calling `authorize`. The default varies by the current runtime.
-     */
-    systemVersion?: string;
-    /**
-     * Whether to automatically call `start` with no parameters in the first `invoke` call. Defaults to `true`.
-     */
-    autoStart?: boolean;
-}
-export interface AnswerCallbackQueryParams {
-    /** Text of the answer */
-    text?: string;
-    /** Pass true to show an alert to the user instead of a toast notification */
-    alert?: boolean;
-    /** URL to be opened */
-    url?: string;
-    /** Time during which the result of the query can be cached, in seconds */
-    cacheTime?: number;
-}
-/**
- * A chat identifier as provided by MTKruto or a string starting with a @ that is followed by a username.
- */
-export type ChatID = number | string;
-export interface SendMessagesParams {
-    /**
-     * The parse mode to use. If not provided, the default parse mode will be used.
-     */
-    parseMode?: ParseMode;
-    /**
-     * The message's entities.
-     */
-    entities?: MessageEntity[];
-    /**
-     * Whether to disable web page previews in the message that is to be sent.
-     */
-    disableWebPagePreview?: boolean;
-    /**
-     * Whether to send the message in a silent way without making a sound on the recipients' clients.
-     */
-    disableNotification?: boolean;
-    /**
-     * Whether to protect the contents of the message from copying and forwarding.
-     */
-    protectContent?: boolean;
-    /**
-     * The identifier of a message to reply to.
-     */
-    replyToMessageId?: number;
-    /**
-     * The identifier of a thread to send the message to.
-     */
-    messageThreadId?: number;
-    /**
-     * The identifier of the chat to send the message on behalf of. User-only.
-     */
-    sendAs?: ChatID;
-    /**
-     * The reply markup of the message. Bot-only.
-     */
-    replyMarkup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
-}
-export interface EditMessageParams {
-    /**
-     * The parse mode to use. If not provided, the default parse mode will be used.
-     */
-    parseMode?: ParseMode;
-    /**
-     * The message's entities.
-     */
-    entities?: MessageEntity[];
-    /**
-     * Whether to disable web page previews in the message that is to be edited.
-     */
-    disableWebPagePreview?: boolean;
-    /**
-     * The reply markup of the message. Bot-only.
-     */
-    replyMarkup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
-}
-export interface ForwardMessagesParams {
-    messageThreadId?: number;
-    /**
-     * Whether to forward the message in a silent way without making a sound on the recipients' clients.
-     */
-    disableNotification?: boolean;
-    /**
-     * Whether to protect the contents of the forwarded message from copying and forwarding.
-     */
-    protectContent?: boolean;
-    /**
-     * The identifier of the chat to forward the message on behalf of. User-only.
-     */
-    sendAs?: ChatID;
-    /**
-     * Whether to not include the original sender of the message that is going to be forwarded.
-     */
-    dropSenderName?: boolean;
-    /**
-     * Whether to not include the original caption of the message that is going to be forwarded.
-     */
-    dropCaption?: boolean;
-}
 export declare class Client extends ClientAbstract {
     readonly storage: Storage;
     readonly apiId: number | null;
@@ -194,6 +57,8 @@ export declare class Client extends ClientAbstract {
      * Before establishing the connection, the session is saved.
      */
     connect(): Promise<void>;
+    private assertUser;
+    private assertBot;
     private fetchState;
     [handleMigrationError](err: types.RPCError): Promise<void>;
     private connectionInited;
@@ -259,13 +124,15 @@ export declare class Client extends ClientAbstract {
     [getEntity](peer: types.PeerChannel): Promise<types.Channel | null>;
     processResult(result: ReadObject): Promise<void>;
     private updatesToMessages;
+    private resolveSendAs;
     /**
      * Send a text message.
      *
      * @param chatId The chat to send the message to.
      * @param text The message's text.
      */
-    sendMessage(chatId: ChatID, text: string, params?: SendMessagesParams): Promise<Message>;
+    sendMessage(chatId: ChatID, text: string, params?: SendMessagesParams): Promise<With<Message, "text">>;
+    private parseText;
     /**
      * Edit a message's text.
      *
@@ -319,34 +186,22 @@ export declare class Client extends ClientAbstract {
      */
     getMe(): Promise<import("../3_types.js").User>;
     private handleUpdate;
-    handler: Handler;
-    use(middleware: Handler): void;
-    on<U extends keyof Update, K extends keyof Update[U]>(filter: U extends FilterableUpdates ? U | [U, K, ...K[]] : U, handler: Handler<Pick<{
-        [P in U]: With<Update[U], K>;
-    }, U>>): void;
+    private _handler;
+    set handler(handler: Handler);
     /**
      * Answer a callback query. Bot-only.
      *
      * @param id ID of the callback query to answer.
      */
     answerCallbackQuery(id: string, params?: AnswerCallbackQueryParams): Promise<void>;
+    private constructReplyMarkup;
+    private static assertMsgHas;
+    /**
+     * Send a poll.
+     *
+     * @param chatId The chat to send the poll to.
+     * @param question The poll's question.
+     * @param options The poll's options.
+     */
+    sendPoll(chatId: ChatID, question: string, options: [string, string, ...string[]], params?: SendPollParams): Promise<With<Message, "poll">>;
 }
-type With<T, K extends keyof T> = T & Required<Pick<T, K>>;
-export type ConnectionState = "not-connected" | "updating" | "ready";
-export type AuthorizationState = {
-    authorized: boolean;
-};
-type FilterableUpdates = "message" | "editedMessage" | "callbackQuery";
-export interface Update {
-    message: Message;
-    editedMessage: Message;
-    connectionState: ConnectionState;
-    authorizationState: AuthorizationState;
-    deletedMessages: [Message, ...Message[]];
-    callbackQuery: CallbackQuery;
-    inlineQuery: InlineQuery;
-}
-export interface Handler<U extends Partial<Update> = Partial<Update>> {
-    (update: U, next: () => Promise<void>): MaybePromise<void>;
-}
-export {};