chz-telegram-bot 0.7.13 → 0.7.15

package/src/types/events.ts

@@ -1,286 +0,0 @@
-import { ChatInfo } from '../dtos/chatInfo';
-import { IncomingMessage } from '../dtos/incomingMessage';
-import { IncomingInlineQuery } from '../dtos/incomingQuery';
-import { CommandAction } from '../entities/actions/commandAction';
-import { ChatContext } from '../entities/context/chatContext';
-import { InlineQueryContext } from '../entities/context/inlineQueryContext';
-import { MessageContext } from '../entities/context/messageContext';
-import { ReplyContext } from '../entities/context/replyContext';
-import { IAction, IActionWithState } from './action';
-import { IActionState } from './actionState';
-import { BotInfo } from './externalAliases';
-import { BotResponse } from './response';
-import { Milliseconds } from './timeValues';
-import { TraceId } from './trace';
-
-export const BotEventType = {
-    error: 'error.generic',
-
-    messageRecieved: 'message.recieved',
-    messageProcessingStarted: 'message.processingStarted',
-    messageProcessingFinished: 'message.processingFinished',
-    beforeActionsExecuting: 'message.beforeActionsExecuting',
-
-    commandActionExecuting: 'command.actionExecuting',
-    commandActionExecuted: 'command.actionExecuted',
-    commandActionCaptureStarted: 'command.captionStarted',
-    commandActionCaptureAborted: 'command.captionAborted',
-
-    replyActionExecuting: 'reply.actionExecuting',
-    replyActionExecuted: 'reply.actionExecuted',
-
-    inlineProcessingStarted: 'inline.processingStarted',
-    inlineProcessingFinished: 'inline.processingFinished',
-    inlineQueryRecieved: 'inline.queryRecieved',
-    inlineActionExecuting: 'inline.actionExecuting',
-    inlineActionExecuted: 'inline.actionExecuted',
-    inlineProcessingAborting: 'inline.processingAborting',
-    inlineProcessingAborted: 'inline.processingAborted',
-
-    scheduledProcessingStarted: 'scheduled.processingStarted',
-    scheduledProcessingFinished: 'scheduled.processingFinished',
-    scheduledActionExecuting: 'scheduled.actionExecuting',
-    scheduledActionExecuted: 'scheduled.actionExecuted',
-    scheduledActionCacheValueReturned: 'scheduled.cachedValueReturned',
-    scheduledActionCacheValueCreating: 'scheduled.cachedValueCreating',
-
-    apiRequestSending: 'api.requestSending',
-    apiRequestSent: 'api.requestSent',
-
-    taskCreated: 'task.created',
-    taskRun: 'task.run',
-
-    botStarting: 'bot.starting',
-    botStopping: 'bot.stopping'
-} as const;
-
-type BotEventTypeKeys = (typeof BotEventType)[keyof typeof BotEventType];
-// Exhaustiveness validation
-const _checkBotEventMapExhaustive: Record<BotEventTypeKeys, unknown> =
-    null as unknown as BotEventMap;
-
-export type BotEventMap = {
-    [BotEventType.error]: {
-        error: Error;
-    };
-
-    [BotEventType.messageRecieved]: {
-        botInfo: BotInfo;
-        message: IncomingMessage;
-    };
-    [BotEventType.messageProcessingStarted]: {
-        botInfo: BotInfo;
-        message: IncomingMessage;
-    };
-    [BotEventType.messageProcessingFinished]: {
-        botInfo: BotInfo;
-        message: IncomingMessage;
-    };
-
-    [BotEventType.beforeActionsExecuting]: {
-        botInfo: BotInfo;
-        message: IncomingMessage;
-        commands: Set<CommandAction<IActionState>>;
-    };
-    [BotEventType.commandActionExecuting]: {
-        action: IActionWithState<IActionState>;
-        ctx: MessageContext<IActionState>;
-        state: IActionState;
-    };
-    [BotEventType.commandActionExecuted]: {
-        action: IActionWithState<IActionState>;
-        ctx: MessageContext<IActionState>;
-        state: IActionState;
-    };
-    [BotEventType.commandActionCaptureStarted]: {
-        parentMessageId: number;
-        chatInfo: ChatInfo;
-    };
-    [BotEventType.commandActionCaptureAborted]: {
-        parentMessageId: number;
-        chatInfo: ChatInfo;
-    };
-
-    [BotEventType.replyActionExecuting]: {
-        action: IAction;
-        ctx: ReplyContext<IActionState>;
-    };
-    [BotEventType.replyActionExecuted]: {
-        action: IAction;
-        ctx: ReplyContext<IActionState>;
-    };
-
-    [BotEventType.inlineProcessingStarted]: {
-        botName: string;
-    };
-    [BotEventType.inlineProcessingFinished]: {
-        botName: string;
-    };
-    [BotEventType.inlineActionExecuting]: {
-        action: IAction;
-        ctx: InlineQueryContext;
-    };
-    [BotEventType.inlineActionExecuted]: {
-        action: IAction;
-        ctx: InlineQueryContext;
-    };
-    [BotEventType.inlineProcessingAborting]: {
-        abortedQuery: IncomingInlineQuery;
-        newQuery: IncomingInlineQuery;
-    };
-    [BotEventType.inlineProcessingAborted]: {
-        abortedQuery: IncomingInlineQuery;
-    };
-    [BotEventType.inlineQueryRecieved]: {
-        query: IncomingInlineQuery;
-    };
-
-    [BotEventType.scheduledProcessingStarted]: {
-        botName: string;
-    };
-    [BotEventType.scheduledProcessingFinished]: { botName: string };
-    [BotEventType.scheduledActionExecuting]: {
-        action: IAction;
-        ctx: ChatContext<IActionState>;
-        state: IActionState;
-    };
-    [BotEventType.scheduledActionExecuted]: {
-        action: IAction;
-        ctx: ChatContext<IActionState>;
-        state: IActionState;
-    };
-    [BotEventType.scheduledActionCacheValueCreating]: {
-        action: IAction;
-        ctx: ChatContext<IActionState>;
-        key: string;
-    };
-    [BotEventType.scheduledActionCacheValueReturned]: {
-        action: IAction;
-        ctx: ChatContext<IActionState>;
-        key: string;
-    };
-
-    [BotEventType.apiRequestSending]: {
-        response: BotResponse | null;
-        telegramMethod: string | null;
-    };
-    [BotEventType.apiRequestSent]: {
-        response: BotResponse | null;
-        telegramMethod: string | null;
-    };
-
-    [BotEventType.taskCreated]: {
-        name: string;
-        ownerName: string;
-        delay?: Milliseconds;
-        interval?: Milliseconds;
-    };
-    [BotEventType.taskRun]: {
-        name: string;
-        ownerName: string;
-        delay?: Milliseconds;
-        interval?: Milliseconds;
-    };
-
-    [BotEventType.botStarting]: {
-        botName: string;
-    };
-    [BotEventType.botStopping]: {
-        botName: string;
-    };
-};
-
-type FullEventMap<TCustom extends Record<string, unknown>> = BotEventMap &
-    TCustom;
-
-type ListenerArgs<
-    TMap extends Record<string, unknown>,
-    K extends keyof TMap
-> = TMap[K] extends undefined
-    ? []
-    : [
-          {
-              traceId: TraceId;
-          } & TMap[K]
-      ];
-
-export type Listener<
-    TMap extends Record<string, unknown>,
-    K extends keyof TMap
-> = (timestamp: number, ...args: ListenerArgs<TMap, K>) => void;
-
-export type EachListener<TMap extends Record<string, unknown> = BotEventMap> = (
-    event: keyof TMap & string,
-    timestamp: number,
-    data: unknown
-) => void;
-
-export class TypedEventEmitter<
-    // eslint-disable-next-line @typescript-eslint/no-empty-object-type
-    TCustomEvents extends Record<string, unknown> = {}
-> {
-    private readonly listeners = new Map<
-        keyof FullEventMap<TCustomEvents> | '*',
-        Set<
-            | Listener<
-                  FullEventMap<TCustomEvents>,
-                  keyof FullEventMap<TCustomEvents>
-              >
-            | EachListener<FullEventMap<TCustomEvents>>
-        >
-    >();
-
-    on<K extends keyof FullEventMap<TCustomEvents>>(
-        event: K,
-        fn: Listener<FullEventMap<TCustomEvents>, K>
-    ) {
-        const set = this.listeners.get(event) ?? new Set();
-        set.add(
-            fn as Listener<
-                FullEventMap<TCustomEvents>,
-                keyof FullEventMap<TCustomEvents>
-            >
-        );
-        this.listeners.set(event, set);
-    }
-
-    onEach(fn: EachListener<FullEventMap<TCustomEvents>>) {
-        const event = '*';
-        const set = this.listeners.get(event) ?? new Set();
-        set.add(fn);
-        this.listeners.set(event, set);
-    }
-
-    emit<K extends keyof FullEventMap<TCustomEvents>>(
-        event: K,
-        ...args: ListenerArgs<FullEventMap<TCustomEvents>, K>
-    ): void {
-        const timestamp = Date.now();
-        const specific = this.listeners.get(event);
-        if (specific) {
-            for (const fn of specific) {
-                (fn as Listener<FullEventMap<TCustomEvents>, K>)(
-                    timestamp,
-                    ...args
-                );
-            }
-        }
-
-        const anySet = this.listeners.get('*');
-        if (anySet) {
-            for (const fn of anySet) {
-                (
-                    fn as unknown as (
-                        e: K,
-                        t: number,
-                        ...a: ListenerArgs<FullEventMap<TCustomEvents>, K>
-                    ) => void
-                )(event, timestamp, ...args);
-            }
-        }
-    }
-
-    events(): (keyof FullEventMap<TCustomEvents> | '*')[] {
-        return [...this.listeners.keys()];
-    }
-}

package/src/types/externalAliases.ts

@@ -1,18 +0,0 @@
-import { Telegram, Telegraf } from 'telegraf';
-import {
-    User,
-    Message,
-    InlineQueryResult,
-    UserFromGetMe,
-    TelegramEmoji as Emoji,
-    InlineKeyboardButton
-} from 'telegraf/types';
-
-export type TelegramUser = User;
-export type TelegramMessage = Message;
-export type TelegramInlineQueryResult = InlineQueryResult;
-export type TelegramEmoji = Emoji;
-export type TelegramApiClient = Telegram;
-export type BotInfo = UserFromGetMe;
-export type TelegramBot = Telegraf;
-export type TelegramInlineKeyboardButton = InlineKeyboardButton;

package/src/types/handlers.ts

@@ -1,26 +0,0 @@
-import { ChatContext } from '../entities/context/chatContext';
-import { InlineQueryContext } from '../entities/context/inlineQueryContext';
-import { MessageContext } from '../entities/context/messageContext';
-import { IActionState } from './actionState';
-import { CachedValueAccessor } from './cachedValueAccessor';
-
-export type InlineQueryHandler = (
-    /** Context of inline query executed in chat, in response to a message. */
-    ctx: InlineQueryContext
-) => Promise<void>;
-
-export type CommandHandler<TActionState extends IActionState> = (
-    /** Context of action executed in chat, in response to a message. */
-    ctx: MessageContext<TActionState>,
-    /** State of an action being executed. */
-    state: TActionState
-) => Promise<void> | void;
-
-export type ScheduledHandler<TActionState extends IActionState> = (
-    /** Context of action executed in chat. */
-    ctx: ChatContext<TActionState>,
-    /** Function that will attempt to get value from cache. If there is no value found, corresponding cached state factory will be called. */
-    getCached: CachedValueAccessor,
-    /** State of an action being executed. */
-    state: TActionState
-) => Promise<void>;

package/src/types/inputFile.ts

@@ -1,4 +0,0 @@
-export interface InputFile {
-    source: string;
-    filename?: string;
-}

package/src/types/messageSendingOptions.ts

@@ -1,10 +0,0 @@
-import { TelegramInlineKeyboardButton } from './externalAliases';
-
-export interface MessageSendingOptions {
-    pin?: boolean;
-}
-
-export interface TextMessageSendingOptions extends MessageSendingOptions {
-    disableWebPreview?: boolean;
-    keyboard?: TelegramInlineKeyboardButton[][];
-}

package/src/types/messageTypes.ts

@@ -1,21 +0,0 @@
-export const INTERNAL_MESSAGE_TYPE_PREFIX = `__msg:`;
-
-export const MessageType = {
-    Any: `${INTERNAL_MESSAGE_TYPE_PREFIX}Any`,
-    Text: `${INTERNAL_MESSAGE_TYPE_PREFIX}Text`,
-    Sticker: `${INTERNAL_MESSAGE_TYPE_PREFIX}Sticker`,
-    Animation: `${INTERNAL_MESSAGE_TYPE_PREFIX}Animation`,
-    Document: `${INTERNAL_MESSAGE_TYPE_PREFIX}Document`,
-    Voice: `${INTERNAL_MESSAGE_TYPE_PREFIX}Voice`,
-    Audio: `${INTERNAL_MESSAGE_TYPE_PREFIX}Audio`,
-    LeftChatMember: `${INTERNAL_MESSAGE_TYPE_PREFIX}LeftChatMember`,
-    NewChatMember: `${INTERNAL_MESSAGE_TYPE_PREFIX}NewChatMember`,
-    Poll: `${INTERNAL_MESSAGE_TYPE_PREFIX}Poll`,
-    Location: `${INTERNAL_MESSAGE_TYPE_PREFIX}Location`,
-    Photo: `${INTERNAL_MESSAGE_TYPE_PREFIX}Photo`,
-    Forward: `${INTERNAL_MESSAGE_TYPE_PREFIX}Forward`,
-    Video: `${INTERNAL_MESSAGE_TYPE_PREFIX}Video`,
-    Unknown: `${INTERNAL_MESSAGE_TYPE_PREFIX}Unknown`
-} as const;
-
-export type MessageTypeValue = (typeof MessageType)[keyof typeof MessageType];

package/src/types/propertyProvider.ts

@@ -1,14 +0,0 @@
-import { ChatContext } from '../entities/context/chatContext';
-import { InlineQueryContext } from '../entities/context/inlineQueryContext';
-import { MessageContext } from '../entities/context/messageContext';
-import { IActionState } from './actionState';
-
-export type CommandActionPropertyProvider<T> = (
-    ctx: MessageContext<IActionState>
-) => T;
-
-export type InlineActionPropertyProvider<T> = (ctx: InlineQueryContext) => T;
-
-export type ScheduledActionPropertyProvider<T> = (
-    ctx: ChatContext<IActionState>
-) => T;

package/src/types/response.ts

@@ -1,51 +0,0 @@
-import { ChatInfo } from '../dtos/chatInfo';
-import { DelayResponse } from '../dtos/responses/delay';
-import { ImageMessage } from '../dtos/responses/imageMessage';
-import { InlineQueryResponse } from '../dtos/responses/inlineQueryResponse';
-import { Reaction } from '../dtos/responses/reaction';
-import { TextMessage } from '../dtos/responses/textMessage';
-import { UnpinResponse } from '../dtos/responses/unpin';
-import { VideoMessage } from '../dtos/responses/videoMessage';
-import { IReplyCapture } from './capture';
-import { ReplyInfo } from '../dtos/replyInfo';
-import { TraceId } from './trace';
-import { IAction } from './action';
-
-export const BotResponseTypes = {
-    unpin: 'unpin',
-    text: 'text',
-    image: 'image',
-    video: 'video',
-    react: 'react',
-    delay: 'delay',
-    inlineQuery: 'inlineQuery'
-} as const;
-
-export type BotResponse =
-    | UnpinResponse
-    | Reaction
-    | TextMessage
-    | VideoMessage
-    | DelayResponse
-    | InlineQueryResponse
-    | ImageMessage;
-
-export interface IChatResponse {
-    readonly kind: keyof typeof BotResponseTypes;
-    readonly chatInfo: ChatInfo;
-    readonly traceId: TraceId;
-    readonly createdAt: number;
-
-    readonly action: IAction;
-}
-
-export interface IReplyResponse extends IChatResponse {
-    readonly captures: IReplyCapture[];
-    readonly replyInfo: ReplyInfo | undefined;
-    readonly disableWebPreview: boolean;
-    readonly shouldPin: boolean;
-}
-
-export interface IReplyResponseWithContent<TType> extends IReplyResponse {
-    readonly content: TType;
-}

package/src/types/scheduler.ts

@@ -1,20 +0,0 @@
-import { Milliseconds } from './timeValues';
-
-export interface IScheduler {
-    stopAll(): void;
-
-    createTask(
-        name: string,
-        action: () => unknown,
-        interval: Milliseconds,
-        executeRightAway: boolean,
-        ownerName: string
-    ): void;
-
-    createOnetimeTask(
-        name: string,
-        action: () => unknown,
-        delay: Milliseconds,
-        ownerName: string
-    ): void;
-}

package/src/types/storage.ts

@@ -1,23 +0,0 @@
-import { IActionState } from './actionState';
-import { IActionWithState } from './action';
-
-export interface IStorageClient {
-    updateStateFor<TActionState extends IActionState>(
-        action: IActionWithState<TActionState>,
-        chatId: number,
-        update: (state: TActionState) => Promise<void> | void
-    ): Promise<void>;
-    close(): Promise<void>;
-    load<TActionState extends IActionState>(
-        action: IActionWithState<TActionState>
-    ): Record<number, TActionState>;
-    getActionState<TActionState extends IActionState>(
-        action: IActionWithState<TActionState>,
-        chatId: number
-    ): TActionState;
-    saveActionExecutionResult<TActionState extends IActionState>(
-        action: IActionWithState<TActionState>,
-        chatId: number,
-        state: TActionState
-    ): Promise<void>;
-}

package/src/types/timeValues.ts

@@ -1,33 +0,0 @@
-declare const millisecondsSymbol: unique symbol;
-declare const secondsSymbol: unique symbol;
-declare const hoursSymbol: unique symbol;
-
-export type Milliseconds = number & { [millisecondsSymbol]: never };
-export type Seconds = number & { [secondsSymbol]: never };
-export type Hours = number & { [hoursSymbol]: never };
-
-export type HoursOfDay =
-    | 0
-    | 1
-    | 2
-    | 3
-    | 4
-    | 5
-    | 6
-    | 7
-    | 8
-    | 9
-    | 10
-    | 11
-    | 12
-    | 13
-    | 14
-    | 15
-    | 16
-    | 17
-    | 18
-    | 19
-    | 20
-    | 21
-    | 22
-    | 23;

package/src/types/trace.ts

@@ -1,5 +0,0 @@
-declare const traceSymbol: unique symbol;
-
-export type TraceId = `${string}:${string}-${string}` & {
-    [traceSymbol]: never;
-};