0-README.md

grammY Auto Answer Callback Query

The plugin allows to automatically answerCallbackQuery when the developer forgets or decides not to do so.

auto-answer-callback-queries-plugin.ts

/**
 * The MIT License (MIT)
 * Copyright © 2024 <slavafomin>
 *
 * 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.
 *
 * Discussion: https://t.me/grammyjs/282614
 */

import type { Context, NextFunction } from 'grammy';


export type AnswerCallbackQueryArgs = (
  Parameters<Context['answerCallbackQuery']>[0]
);

export type AutoAnswerCallbackQueryFn = (
  (args: AnswerCallbackQueryArgs) => void
);

export interface AutoAnswerCallbackQueriesFlavor {

  autoAnswerCallbackQuery: AutoAnswerCallbackQueryFn;

}

export interface AutoAnswerCallbackQueriesOptions {

  defaultAnswerCallbackQueryArgs?: (
    | AnswerCallbackQueryArgs
    | undefined
  );

}


export function useAutoAnswerCallbackQueries(
  options?: AutoAnswerCallbackQueriesOptions
) {

  return async (context: Context, next: NextFunction) => {

    // Allowing users to customize arguments that are sent
    // to the answerCallbackQuery().
    let autoAnswerCallbackQueryArgs: (
      | AnswerCallbackQueryArgs
      | undefined

    ) = options?.defaultAnswerCallbackQueryArgs;

    Object.defineProperty(context, 'autoAnswerCallbackQuery', {
      value: <AutoAnswerCallbackQueryFn> (
        (args: AnswerCallbackQueryArgs) => {
          autoAnswerCallbackQueryArgs = args;
        }
      )
    });

    const callbackQueryId = context.callbackQuery?.id;

    if (!callbackQueryId) {
      return next();
    }

    let isAnswered = false;

    context.api.config.use(
      (prev, method, payload, signal) => {

        // Marking callback queries as answered if user
        // answers them manually to prevent the auto-answer.
        if (method === 'answerCallbackQuery') {
          isAnswered = true;
        }

        return prev(method, payload, signal);

      }
    );

    try {

      return await next();

    } finally {

      // Auto-answering the callback query if it wasn't
      // answered by the user.
      if (!isAnswered) {
        await context.answerCallbackQuery(
          autoAnswerCallbackQueryArgs
        );
      }

    }

  };

}