chz-telegram-bot 0.7.14 → 0.7.16

package/dist/services/jsonFileStorage.js

@@ -93,7 +93,7 @@ export class JsonFileStorage {
     async updateStateFor(action, chatId, update) {
         await this.lock(action.key, async () => {
             const data = this.data.load(action);
-            const state = data[chatId];
+            const state = data[chatId] ?? action.stateConstructor();
             await update(state);
             data[chatId] = state;
             await this.data.save(data, action);

package/package.json

@@ -14,7 +14,7 @@
         "type": "git",
         "url": "https://github.com/AlexSolari/botFramework.git"
     },
-    "version": "0.7.14",
+    "version": "0.7.16",
     "type": "module",
     "dependencies": {
         "async-sema": "^3.1.1",
@@ -23,6 +23,9 @@
     },
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
+    "files": [
+        "dist"
+    ],
     "devDependencies": {
         "@eslint/js": "^9.39.4",
         "@types/bun": "^1.3.11",

package/eslint.config.ts

@@ -1,62 +0,0 @@
-/// <reference types="node" />
-import eslint from '@eslint/js';
-import tseslint from 'typescript-eslint';
-import parser from '@typescript-eslint/parser';
-import { defineConfig } from 'eslint/config';
-import { fileURLToPath } from 'node:url';
-import { dirname } from 'node:path';
-
-const __dirname = dirname(fileURLToPath(import.meta.url));
-
-export default defineConfig(
-    {
-        ignores: ['dist/**', 'eslint.config.ts']
-    },
-    eslint.configs.recommended,
-    tseslint.configs.strictTypeChecked,
-    {
-        languageOptions: {
-            parser,
-            parserOptions: {
-                tsconfigRootDir: __dirname,
-                sourceType: 'module',
-                projectService: true
-            }
-        },
-        plugins: { '@typescript-eslint': tseslint.plugin },
-        rules: {
-            '@typescript-eslint/switch-exhaustiveness-check': 'error',
-            '@typescript-eslint/no-unused-vars': [
-                'error',
-                {
-                    args: 'all',
-                    argsIgnorePattern: '^_',
-                    caughtErrors: 'all',
-                    caughtErrorsIgnorePattern: '^_',
-                    destructuredArrayIgnorePattern: '^_',
-                    varsIgnorePattern: '^_',
-                    ignoreRestSiblings: true
-                }
-            ],
-            '@typescript-eslint/no-misused-promises': [
-                'error',
-                {
-                    checksVoidReturn: true,
-                    checksConditionals: true
-                }
-            ],
-            '@typescript-eslint/restrict-template-expressions': [
-                'error',
-                {
-                    allowNumber: true
-                }
-            ],
-            '@typescript-eslint/unbound-method': [
-                'error',
-                {
-                    ignoreStatic: true
-                }
-            ]
-        }
-    }
-);

package/src/builtin/helpAction.ts

@@ -1,17 +0,0 @@
-import { CommandActionBuilder } from '../helpers/builders/commandActionBuilder';
-import { Seconds } from '../types/timeValues';
-
-export function buildHelpCommand(readmes: string[], botUsername: string) {
-    const helpCommandBuilder = new CommandActionBuilder('Reaction.Help')
-        .on(['/help', `/help@${botUsername}`])
-        .do((ctx) => {
-            ctx.reply.withText(readmes.join('\n\n'));
-        })
-        .withCooldown({
-            cooldown: 60 as Seconds
-        });
-
-    if (readmes.length == 0) helpCommandBuilder.disabled();
-
-    return helpCommandBuilder.build();
-}

package/src/dtos/chatHistoryMessage.ts

@@ -1,22 +0,0 @@
-import { TelegramUser } from '../types/externalAliases';
-import { MessageTypeValue } from '../types/messageTypes';
-import { TraceId } from '../types/trace';
-
-export class ChatHistoryMessage {
-    constructor(
-        /** The unique identifier for the message */
-        readonly id: number,
-        /** The user who sent the message */
-        readonly from: TelegramUser | undefined,
-        /** The content of the message */
-        readonly text: string,
-        /** The type of the message */
-        readonly type: MessageTypeValue,
-        /** The trace identifier for the message */
-        readonly traceId: TraceId,
-        /** The identifier for the message this message is replying to */
-        readonly replyToId: number | undefined,
-        /** The date the message was sent, represented as a Unix timestamp */
-        readonly date: number
-    ) {}
-}

package/src/dtos/chatInfo.ts

@@ -1,12 +0,0 @@
-import { ChatHistoryMessage } from './chatHistoryMessage';
-
-export class ChatInfo {
-    constructor(
-        /** Id of a chat that action is executed in. */
-        readonly id: number,
-        /** Name of a chat that action is executed in. */
-        readonly name: string,
-        /** Last 100 messages in chat where action is executed */
-        readonly messageHistory: ChatHistoryMessage[]
-    ) {}
-}

package/src/dtos/commandTriggerCheckResult.ts

@@ -1,40 +0,0 @@
-const _SkipTriggerReasonsObject = {
-    UserIdMissing: 'UserIdMissing',
-    UserForbidden: 'UserForbidden',
-    OnCooldown: 'OnCooldown',
-    CustomConditionNotMet: 'CustomConditionNotMet',
-    TriggerNotSatisfied: 'TriggerNotSatisfied',
-    Other: 'Other',
-    ActionDisabled: 'ActionDisabled',
-    ChatForbidden: 'ChatForbidden'
-} as const;
-
-export type SkipTriggerReasons = keyof typeof _SkipTriggerReasonsObject;
-
-export class CommandTriggerCheckResult {
-    static DontTriggerAndSkipCooldown(reason: SkipTriggerReasons) {
-        return new CommandTriggerCheckResult(false, [], true, reason);
-    }
-    static DoNotTrigger(reason: SkipTriggerReasons) {
-        return new CommandTriggerCheckResult(false, [], false, reason);
-    }
-    static Trigger() {
-        return new CommandTriggerCheckResult(true, [], false);
-    }
-
-    constructor(
-        readonly shouldExecute: boolean,
-        readonly matchResults: RegExpExecArray[],
-        readonly skipCooldown: boolean,
-        readonly reason?: SkipTriggerReasons
-    ) {}
-
-    mergeWith(other: CommandTriggerCheckResult) {
-        return new CommandTriggerCheckResult(
-            this.shouldExecute || other.shouldExecute,
-            this.matchResults.concat(other.matchResults),
-            this.skipCooldown || other.skipCooldown,
-            other.reason
-        );
-    }
-}

package/src/dtos/cooldownInfo.ts

@@ -1,10 +0,0 @@
-import { Seconds } from '../types/timeValues';
-
-export class CooldownInfo {
-    constructor(
-        /** Cooldown configuration */
-        readonly cooldown: Seconds,
-        /** Cooldown message to be shown */
-        readonly message?: string
-    ) {}
-}

package/src/dtos/incomingMessage.ts

@@ -1,71 +0,0 @@
-import { randomInt } from 'crypto';
-import { MessageType, MessageTypeValue } from '../types/messageTypes';
-import { ChatInfo } from './chatInfo';
-import { createTrace } from '../helpers/traceFactory';
-import { TraceId } from '../types/trace';
-import { ChatHistoryMessage } from './chatHistoryMessage';
-import { TelegramMessage, TelegramUser } from '../types/externalAliases';
-
-export class IncomingMessage {
-    readonly messageId: number;
-    readonly chatInfo: ChatInfo;
-    readonly from: TelegramUser | undefined;
-    readonly text: string;
-    readonly type: MessageTypeValue;
-    readonly traceId: TraceId;
-    readonly replyToMessageId: number | undefined;
-
-    readonly updateObject: TelegramMessage;
-
-    private detectMessageType(message: TelegramMessage) {
-        if ('forward_origin' in message) return MessageType.Forward;
-        if ('text' in message) return MessageType.Text;
-        if ('video' in message) return MessageType.Video;
-        if ('photo' in message) return MessageType.Photo;
-        if ('sticker' in message) return MessageType.Sticker;
-        if ('animation' in message) return MessageType.Animation;
-        if ('voice' in message) return MessageType.Voice;
-        if ('audio' in message) return MessageType.Audio;
-        if ('document' in message) return MessageType.Document;
-        if ('left_chat_member' in message) return MessageType.LeftChatMember;
-        if ('new_chat_member' in message) return MessageType.NewChatMember;
-        if ('poll' in message) return MessageType.Poll;
-        if ('location' in message) return MessageType.Location;
-
-        return MessageType.Unknown;
-    }
-
-    constructor(
-        ctxMessage: TelegramMessage,
-        botName: string,
-        history: ChatHistoryMessage[]
-    ) {
-        this.traceId = createTrace(
-            this,
-            botName,
-            randomInt(10000, 99999).toString()
-        );
-        this.messageId = ctxMessage.message_id;
-        this.replyToMessageId =
-            'reply_to_message' in ctxMessage
-                ? ctxMessage.reply_to_message?.message_id
-                : undefined;
-        this.from = ctxMessage.from;
-        this.text = this.getMessageText(ctxMessage);
-        this.chatInfo = new ChatInfo(
-            ctxMessage.chat.id,
-            'title' in ctxMessage.chat
-                ? `${ctxMessage.chat.title} ${ctxMessage.chat.id}`
-                : 'DM',
-            history
-        );
-        this.type = this.detectMessageType(ctxMessage);
-        this.updateObject = ctxMessage;
-    }
-
-    private getMessageText(ctxMessage: TelegramMessage) {
-        if ('text' in ctxMessage) return ctxMessage.text;
-
-        return 'caption' in ctxMessage ? ctxMessage.caption ?? '' : '';
-    }
-}

package/src/dtos/incomingQuery.ts

@@ -1,14 +0,0 @@
-import { TraceId } from '../types/trace';
-
-export class IncomingInlineQuery {
-    readonly abortController: AbortController;
-
-    constructor(
-        readonly queryId: string,
-        readonly query: string,
-        readonly userId: number,
-        readonly traceId: TraceId
-    ) {
-        this.abortController = new AbortController();
-    }
-}

package/src/dtos/messageInfo.ts

@@ -1,15 +0,0 @@
-import { TelegramMessage } from '../types/externalAliases';
-import { MessageTypeValue } from '../types/messageTypes';
-
-export class MessageInfo {
-    constructor(
-        /** Id of a message that triggered this action. */
-        readonly id: number,
-        /** Text of a message that triggered this action. */
-        readonly text: string,
-        /** Type of message being received */
-        readonly type: MessageTypeValue,
-        /** Message object recieved from Telegram */
-        readonly telegramUpdateObject: TelegramMessage
-    ) {}
-}

package/src/dtos/propertyProviderSets.ts

@@ -1,20 +0,0 @@
-import { CooldownInfo } from './cooldownInfo';
-import {
-    CommandActionPropertyProvider,
-    ScheduledActionPropertyProvider
-} from '../types/propertyProvider';
-import { HoursOfDay } from '../types/timeValues';
-
-export type CommandActionProviders = {
-    cooldownProvider: CommandActionPropertyProvider<CooldownInfo>;
-    isActiveProvider: CommandActionPropertyProvider<boolean>;
-    chatsBlacklistProvider: CommandActionPropertyProvider<number[]>;
-    chatsWhitelistProvider: CommandActionPropertyProvider<number[]>;
-    usersWhitelistProvider: CommandActionPropertyProvider<number[]>;
-};
-
-export type ScheduledActionProviders = {
-    timeinHoursProvider: ScheduledActionPropertyProvider<HoursOfDay>;
-    isActiveProvider: ScheduledActionPropertyProvider<boolean>;
-    chatsWhitelistProvider: ScheduledActionPropertyProvider<number[]>;
-};

package/src/dtos/replyInfo.ts

@@ -1,9 +0,0 @@
-export class ReplyInfo {
-    readonly id: number;
-    readonly quote: string | undefined;
-
-    constructor(id: number, quote?: string) {
-        this.id = id;
-        this.quote = quote;
-    }
-}

package/src/dtos/responses/delay.ts

@@ -1,28 +0,0 @@
-import { IActionState } from '../../types/actionState';
-import { IActionWithState } from '../../types/action';
-import { BotResponseTypes, IChatResponse } from '../../types/response';
-import { Milliseconds } from '../../types/timeValues';
-import { TraceId } from '../../types/trace';
-import { ChatInfo } from '../chatInfo';
-
-export class DelayResponse implements IChatResponse {
-    readonly kind = BotResponseTypes.delay;
-    readonly createdAt = Date.now();
-
-    readonly chatInfo: ChatInfo;
-    readonly traceId: TraceId;
-    readonly delay: Milliseconds;
-    readonly action: IActionWithState<IActionState>;
-
-    constructor(
-        delay: Milliseconds,
-        chatInfo: ChatInfo,
-        traceId: TraceId,
-        action: IActionWithState<IActionState>
-    ) {
-        this.chatInfo = chatInfo;
-        this.delay = delay;
-        this.traceId = traceId;
-        this.action = action;
-    }
-}

package/src/dtos/responses/imageMessage.ts

@@ -1,41 +0,0 @@
-import {
-    BotResponseTypes,
-    IReplyResponseWithContent
-} from '../../types/response';
-import { MessageSendingOptions } from '../../types/messageSendingOptions';
-import { IAction } from '../../types/action';
-import { ChatInfo } from '../chatInfo';
-import { TraceId } from '../../types/trace';
-import { ReplyInfo } from '../replyInfo';
-import { IReplyCapture } from '../../types/capture';
-import { InputFile } from '../../types/inputFile';
-
-export class ImageMessage implements IReplyResponseWithContent<InputFile> {
-    readonly kind = BotResponseTypes.image;
-    readonly createdAt = Date.now();
-    readonly captures: IReplyCapture[] = [];
-
-    readonly content: InputFile;
-    readonly chatInfo: ChatInfo;
-    readonly replyInfo: ReplyInfo | undefined;
-    readonly traceId: TraceId;
-    readonly disableWebPreview = false;
-    readonly shouldPin: boolean;
-    readonly action: IAction;
-
-    constructor(
-        image: InputFile,
-        chatInfo: ChatInfo,
-        traceId: TraceId,
-        action: IAction,
-        replyInfo: ReplyInfo | undefined,
-        options?: MessageSendingOptions
-    ) {
-        this.content = image;
-        this.chatInfo = chatInfo;
-        this.replyInfo = replyInfo;
-        this.traceId = traceId;
-        this.shouldPin = options?.pin ?? false;
-        this.action = action;
-    }
-}

package/src/dtos/responses/inlineQueryResponse.ts

@@ -1,26 +0,0 @@
-import { InlineQueryAction } from '../../entities/actions/inlineQueryAction';
-import { TelegramInlineQueryResult } from '../../types/externalAliases';
-import { BotResponseTypes } from '../../types/response';
-import { TraceId } from '../../types/trace';
-
-export class InlineQueryResponse {
-    readonly kind = BotResponseTypes.inlineQuery;
-    readonly createdAt = Date.now();
-
-    readonly queryId: string;
-    readonly traceId: TraceId;
-    readonly action: InlineQueryAction;
-    readonly queryResults: TelegramInlineQueryResult[];
-
-    constructor(
-        queryResult: TelegramInlineQueryResult[],
-        queryId: string,
-        traceId: TraceId,
-        action: InlineQueryAction
-    ) {
-        this.queryResults = queryResult;
-        this.queryId = queryId;
-        this.traceId = traceId;
-        this.action = action;
-    }
-}

package/src/dtos/responses/reaction.ts

@@ -1,30 +0,0 @@
-import { BotResponseTypes, IChatResponse } from '../../types/response';
-import { IAction } from '../../types/action';
-import { ChatInfo } from '../chatInfo';
-import { TraceId } from '../../types/trace';
-import { TelegramEmoji } from '../../types/externalAliases';
-
-export class Reaction implements IChatResponse {
-    readonly kind = BotResponseTypes.react;
-    readonly createdAt = Date.now();
-
-    readonly chatInfo: ChatInfo;
-    readonly messageId: number;
-    readonly traceId: TraceId;
-    readonly emoji: TelegramEmoji;
-    readonly action: IAction;
-
-    constructor(
-        traceId: TraceId,
-        chatInfo: ChatInfo,
-        messageId: number,
-        emoji: TelegramEmoji,
-        action: IAction
-    ) {
-        this.chatInfo = chatInfo;
-        this.messageId = messageId;
-        this.emoji = emoji;
-        this.traceId = traceId;
-        this.action = action;
-    }
-}

package/src/dtos/responses/textMessage.ts

@@ -1,44 +0,0 @@
-import { TextMessageSendingOptions } from '../../types/messageSendingOptions';
-import {
-    BotResponseTypes,
-    IReplyResponseWithContent
-} from '../../types/response';
-import { IAction } from '../../types/action';
-import { ChatInfo } from '../chatInfo';
-import { TraceId } from '../../types/trace';
-import { ReplyInfo } from '../replyInfo';
-import { IReplyCapture } from '../../types/capture';
-import { TelegramInlineKeyboardButton } from '../../types/externalAliases';
-
-export class TextMessage implements IReplyResponseWithContent<string> {
-    readonly kind = BotResponseTypes.text;
-    readonly createdAt = Date.now();
-    readonly captures: IReplyCapture[] = [];
-
-    readonly content: string;
-    readonly chatInfo: ChatInfo;
-    readonly replyInfo: ReplyInfo | undefined;
-    readonly traceId: TraceId;
-    readonly disableWebPreview: boolean;
-    readonly shouldPin: boolean;
-    readonly action: IAction;
-    readonly keyboard?: TelegramInlineKeyboardButton[][];
-
-    constructor(
-        text: string,
-        chatInfo: ChatInfo,
-        traceId: TraceId,
-        action: IAction,
-        replyInfo?: ReplyInfo,
-        options?: TextMessageSendingOptions
-    ) {
-        this.content = text;
-        this.chatInfo = chatInfo;
-        this.replyInfo = replyInfo;
-        this.traceId = traceId;
-        this.disableWebPreview = options?.disableWebPreview ?? false;
-        this.shouldPin = options?.pin ?? false;
-        this.action = action;
-        this.keyboard = options?.keyboard;
-    }
-}

package/src/dtos/responses/unpin.ts

@@ -1,27 +0,0 @@
-import { BotResponseTypes, IChatResponse } from '../../types/response';
-import { IActionWithState } from '../../types/action';
-import { IActionState } from '../../types/actionState';
-import { ChatInfo } from '../chatInfo';
-import { TraceId } from '../../types/trace';
-
-export class UnpinResponse implements IChatResponse {
-    readonly kind = BotResponseTypes.unpin;
-    readonly createdAt = Date.now();
-
-    readonly messageId: number;
-    readonly chatInfo: ChatInfo;
-    readonly traceId: TraceId;
-    readonly action: IActionWithState<IActionState>;
-
-    constructor(
-        messageId: number,
-        chatInfo: ChatInfo,
-        traceId: TraceId,
-        action: IActionWithState<IActionState>
-    ) {
-        this.messageId = messageId;
-        this.chatInfo = chatInfo;
-        this.traceId = traceId;
-        this.action = action;
-    }
-}

package/src/dtos/responses/videoMessage.ts

@@ -1,41 +0,0 @@
-import {
-    BotResponseTypes,
-    IReplyResponseWithContent
-} from '../../types/response';
-import { MessageSendingOptions } from '../../types/messageSendingOptions';
-import { IAction } from '../../types/action';
-import { ChatInfo } from '../chatInfo';
-import { TraceId } from '../../types/trace';
-import { ReplyInfo } from '../replyInfo';
-import { IReplyCapture } from '../../types/capture';
-import { InputFile } from '../../types/inputFile';
-
-export class VideoMessage implements IReplyResponseWithContent<InputFile> {
-    readonly kind = BotResponseTypes.video;
-    readonly createdAt = Date.now();
-    readonly captures: IReplyCapture[] = [];
-
-    readonly content: InputFile;
-    readonly chatInfo: ChatInfo;
-    readonly replyInfo: ReplyInfo | undefined;
-    readonly traceId: TraceId;
-    readonly disableWebPreview = false;
-    readonly shouldPin: boolean;
-    readonly action: IAction;
-
-    constructor(
-        video: InputFile,
-        chatInfo: ChatInfo,
-        traceId: TraceId,
-        action: IAction,
-        replyInfo: ReplyInfo | undefined,
-        options?: MessageSendingOptions
-    ) {
-        this.content = video;
-        this.chatInfo = chatInfo;
-        this.replyInfo = replyInfo;
-        this.traceId = traceId;
-        this.shouldPin = options?.pin ?? false;
-        this.action = action;
-    }
-}

package/src/dtos/userInfo.ts

@@ -1,8 +0,0 @@
-export class UserInfo {
-    constructor(
-        /** Id of a user that sent a message that triggered this action. */
-        readonly id: number,
-        /** Name of a user that sent a message that triggered this action. */
-        readonly name: string
-    ) {}
-}