feat: remove "Telegraf" prefix from decorator names

lib/decorators/action.decorator.ts

@@ -5,18 +5,23 @@ import { Context } from '../interfaces';
 
 export type TelegrafActionTriggers = HearsTriggers<Context>;
 
-export interface TelegrafActionMetadata {
+export interface ActionOptions {
   triggers: TelegrafActionTriggers;
 }
 
 /**
  * Registers middleware for handling callback_data actions with regular expressions.
- * @param triggers Triggers
  *
- * https://telegraf.js.org/#/?id=action
+ * @see https://telegraf.js.org/#/?id=action
  */
-export function TelegrafAction(
-  triggers: TelegrafActionTriggers,
-): MethodDecorator {
+export const Action = (triggers: TelegrafActionTriggers): MethodDecorator => {
   return SetMetadata(DECORATORS.ACTION, { triggers });
-}
+};
+
+/**
+ * Registers middleware for handling callback_data actions with regular expressions.
+ *
+ * @see https://telegraf.js.org/#/?id=action
+ * @deprecated since v2, use Action decorator instead.
+ */
+export const TelegrafAction = Action;

lib/decorators/cashtag.decorator.ts

@@ -0,0 +1,25 @@
+import { SetMetadata } from '@nestjs/common';
+import { DECORATORS } from '../telegraf.constants';
+
+export type TelegrafCashtagCashtag = string | string[];
+
+export interface CashtagOptions {
+  cashtag: TelegrafCashtagCashtag;
+}
+
+/**
+ * Cashtag handling.
+ *
+ * @see https://telegraf.js.org/#/?id=cashtag
+ */
+export const Cashtag = (cashtag: TelegrafCashtagCashtag): MethodDecorator => {
+  return SetMetadata(DECORATORS.CASHTAG, { cashtag });
+};
+
+/**
+ * Cashtag handling.
+ *
+ * @see https://telegraf.js.org/#/?id=cashtag
+ * @deprecated since v2, use Cashtag decorator instead.
+ */
+export const TelegrafCashtag = Cashtag;

lib/decorators/command.decorator.ts

@@ -0,0 +1,25 @@
+import { SetMetadata } from '@nestjs/common';
+import { DECORATORS } from '../telegraf.constants';
+
+export type TelegrafCommandCommands = string | string[];
+
+export interface CommandOptions {
+  commands: TelegrafCommandCommands;
+}
+
+/**
+ * Command handling.
+ *
+ * @see https://telegraf.js.org/#/?id=command
+ */
+export const Command = (commands: TelegrafCommandCommands): MethodDecorator => {
+  return SetMetadata(DECORATORS.COMMAND, { commands });
+};
+
+/**
+ * Command handling.
+ *
+ * @see https://telegraf.js.org/#/?id=command
+ * @deprecated since v2, use Command decorator instead.
+ */
+export const TelegrafCommand = Command;

lib/decorators/entity.decorator.ts

@@ -0,0 +1,30 @@
+import { SetMetadata } from '@nestjs/common';
+import { DECORATORS } from '../telegraf.constants';
+
+export type TelegrafEntityEntity =
+  | string
+  | string[]
+  | RegExp
+  | RegExp[]
+  | Function;
+
+export interface EntityOptions {
+  entity: TelegrafEntityEntity;
+}
+
+/**
+ * Entity handling.
+ *
+ * @see https://telegraf.js.org/#/?id=entity
+ */
+export const Entity = (entity: TelegrafEntityEntity): MethodDecorator => {
+  return SetMetadata(DECORATORS.ENTITY, { entity });
+};
+
+/**
+ * Entity handling.
+ *
+ * @see https://telegraf.js.org/#/?id=entity
+ * @deprecated since v2, use Entity decorator instead.
+ */
+export const TelegrafEntity = Entity;

lib/decorators/game-query.decorator.ts

@@ -0,0 +1,19 @@
+import { SetMetadata } from '@nestjs/common';
+import { DECORATORS } from '../telegraf.constants';
+
+/**
+ * Registers middleware for handling callback_data actions with game query.
+ *
+ * @see https://telegraf.js.org/#/?id=inlinequery
+ */
+export const GameQuery = (): MethodDecorator => {
+  return SetMetadata(DECORATORS.GAME_QUERY, {});
+};
+
+/**
+ * Registers middleware for handling callback_data actions with game query.
+ *
+ * @see https://telegraf.js.org/#/?id=inlinequery
+ * @deprecated since v2, use Action decorator instead.
+ */
+export const TelegrafGameQuery = GameQuery;

lib/decorators/hashtag.decorator.ts

@@ -0,0 +1,25 @@
+import { SetMetadata } from '@nestjs/common';
+import { DECORATORS } from '../telegraf.constants';
+
+export type TelegrafHashtagHashtag = string | string[];
+
+export interface HashtagOptions {
+  hashtag: TelegrafHashtagHashtag;
+}
+
+/**
+ * Hashtag handling.
+ *
+ * @see https://telegraf.js.org/#/?id=hashtag
+ */
+export const Hashtag = (hashtag: TelegrafHashtagHashtag): MethodDecorator => {
+  return SetMetadata(DECORATORS.HASHTAG, { hashtag });
+};
+
+/**
+ * Hashtag handling.
+ *
+ * @see https://telegraf.js.org/#/?id=hashtag
+ * @deprecated since v2, use Hashtag decorator instead.
+ */
+export const TelegrafHashtag = Hashtag;

lib/decorators/hears.decorator.ts

@@ -5,18 +5,23 @@ import { Context } from '../interfaces';
 
 export type TelegrafHearsTriggers = HearsTriggers<Context>;
 
-export interface TelegrafHearsMetadata {
+export interface HearsOptions {
   triggers: TelegrafHearsTriggers;
 }
 
 /**
  * Registers middleware for handling text messages.
- * @param triggers Triggers
  *
- * https://telegraf.js.org/#/?id=hears
+ * @see https://telegraf.js.org/#/?id=hears
  */
-export function TelegrafHears(
-  triggers: TelegrafHearsTriggers,
-): MethodDecorator {
+export const Hears = (triggers: TelegrafHearsTriggers): MethodDecorator => {
   return SetMetadata(DECORATORS.HEARS, { triggers: triggers });
-}
+};
+
+/**
+ * Registers middleware for handling text messages.
+ *
+ * @see https://telegraf.js.org/#/?id=hears
+ * @deprecated since v2, use Hears decorator instead.
+ */
+export const TelegrafHears = Hears;

lib/decorators/help.decorator.ts

@@ -0,0 +1,19 @@
+import { SetMetadata } from '@nestjs/common';
+import { DECORATORS } from '../telegraf.constants';
+
+/**
+ * Handler for /help command.
+ *
+ * @see https://telegraf.js.org/#/?id=help
+ */
+export const Help = (): MethodDecorator => {
+  return SetMetadata(DECORATORS.HELP, {});
+};
+
+/**
+ * Handler for /help command.
+ *
+ * @see https://telegraf.js.org/#/?id=help
+ * @deprecated since v2, use Help decorator instead.
+ */
+export const TelegrafHelp = Help;

lib/decorators/index.ts

@@ -1,17 +1,17 @@
+export * from './action.decorator';
+export * from './cashtag.decorator';
+export * from './command.decorator';
+export * from './entity.decorator';
+export * from './game-query.decorator';
+export * from './hashtag.decorator';
+export * from './hears.decorator';
+export * from './help.decorator';
 export * from './inject-bot.decorator';
-export * from './telegraf-use.decorator';
-export * from './telegraf-on.decorator';
-export * from './telegraf-hears.decorator';
-export * from './telegraf-command.decorator';
-export * from './telegraf-start.decorator';
-export * from './telegraf-help.decorator';
-export * from './telegraf-settings.decorator';
-export * from './telegraf-entity.decorator';
-export * from './telegraf-mention.decorator';
-export * from './telegraf-phone.decorator';
-export * from './telegraf-hashtag.decorator';
-export * from './telegraf-cashtag.decorator';
-export * from './telegraf-action.decorator';
-export * from './telegraf-inline-query.decorator';
-export * from './telegraf-game-query.decorator';
+export * from './inline-query.decorator';
+export * from './mention.decorator';
+export * from './on.decorator';
+export * from './phone.decorator';
+export * from './settings.decorator';
+export * from './start.decorator';
 export * from './update.decorator';
+export * from './use.decorator';

lib/decorators/inline-query.decorator.ts

@@ -3,18 +3,25 @@ import { DECORATORS } from '../telegraf.constants';
 
 export type TelegrafInlineQueryTriggers = string | string[] | RegExp | RegExp[];
 
-export interface TelegrafInlineQueryMetadata {
+export interface InlineQueryOptions {
   triggers: TelegrafInlineQueryTriggers;
 }
 
 /**
  * Registers middleware for handling inline_query actions with regular expressions.
- * @param triggers Triggers
  *
- * https://telegraf.js.org/#/?id=inlinequery
+ * @see https://telegraf.js.org/#/?id=inlinequery
  */
-export function TelegrafInlineQuery(
+export const InlineQuery = (
   triggers: TelegrafInlineQueryTriggers,
-): MethodDecorator {
+): MethodDecorator => {
   return SetMetadata(DECORATORS.INLINE_QUERY, { triggers });
-}
+};
+
+/**
+ * Registers middleware for handling inline_query actions with regular expressions.
+ *
+ * @see https://telegraf.js.org/#/?id=inlinequery
+ * @deprecated since v2, use InlineQuery decorator instead.
+ */
+export const TelegrafInlineQuery = InlineQuery;

lib/decorators/mention.decorator.ts

@@ -0,0 +1,25 @@
+import { SetMetadata } from '@nestjs/common';
+import { DECORATORS } from '../telegraf.constants';
+
+export type TelegrafMentionUsername = string | string[];
+
+export interface MentionOptions {
+  username: TelegrafMentionUsername;
+}
+
+/**
+ * Mention handling.
+ *
+ * @see https://telegraf.js.org/#/?id=mention
+ */
+export const Mention = (username: TelegrafMentionUsername): MethodDecorator => {
+  return SetMetadata(DECORATORS.MENTION, { username });
+};
+
+/**
+ * Mention handling.
+ *
+ * @see https://telegraf.js.org/#/?id=mention
+ * @deprecated since v2, use Mention decorator instead.
+ */
+export const TelegrafMention = Mention;

lib/decorators/on.decorator.ts

@@ -8,18 +8,23 @@ export type TelegrafOnUpdateTypes =
   | MessageSubTypes
   | MessageSubTypes[];
 
-export interface TelegrafOnMetadata {
+export interface OnOptions {
   updateTypes: TelegrafOnUpdateTypes;
 }
 
 /**
  * Registers middleware for provided update type.
- * @param updateTypes Update type
  *
- * https://telegraf.js.org/#/?id=on
+ * @see https://telegraf.js.org/#/?id=on
  */
-export function TelegrafOn(
-  updateTypes: TelegrafOnUpdateTypes,
-): MethodDecorator {
+export const On = (updateTypes: TelegrafOnUpdateTypes): MethodDecorator => {
   return SetMetadata(DECORATORS.ON, { updateTypes: updateTypes });
-}
+};
+
+/**
+ * Registers middleware for provided update type.
+ *
+ * @see https://telegraf.js.org/#/?id=on
+ * @deprecated since v2, use On decorator instead.
+ */
+export const TelegrafOn = On;

lib/decorators/phone.decorator.ts

@@ -0,0 +1,25 @@
+import { SetMetadata } from '@nestjs/common';
+import { DECORATORS } from '../telegraf.constants';
+
+export type TelegrafPhonePhone = string | string[];
+
+export interface PhoneOptions {
+  phone: TelegrafPhonePhone;
+}
+
+/**
+ * Phone number handling.
+ *
+ * @see https://telegraf.js.org/#/?id=phone
+ */
+export const Phone = (phone: TelegrafPhonePhone): MethodDecorator => {
+  return SetMetadata(DECORATORS.PHONE, { phone });
+};
+
+/**
+ * Phone number handling.
+ *
+ * @see https://telegraf.js.org/#/?id=phone
+ * @deprecated since v2, use Phone decorator instead.
+ */
+export const TelegrafPhone = Phone;

lib/decorators/settings.decorator.ts

@@ -0,0 +1,19 @@
+import { SetMetadata } from '@nestjs/common';
+import { DECORATORS } from '../telegraf.constants';
+
+/**
+ * Handler for /settings command.
+ *
+ * @see https://telegraf.js.org/#/?id=settings
+ */
+export const Settings = (): MethodDecorator => {
+  return SetMetadata(DECORATORS.SETTINGS, {});
+};
+
+/**
+ * Handler for /settings command.
+ *
+ * @see https://telegraf.js.org/#/?id=settings
+ * @deprecated since v2, use Settings decorator instead.
+ */
+export const TelegrafSettings = Settings;

lib/decorators/start.decorator.ts

@@ -0,0 +1,19 @@
+import { SetMetadata } from '@nestjs/common';
+import { DECORATORS } from '../telegraf.constants';
+
+/**
+ * Handler for /start command.
+ *
+ * @see https://telegraf.js.org/#/?id=start
+ */
+export const Start = (): MethodDecorator => {
+  return SetMetadata(DECORATORS.START, {});
+};
+
+/**
+ * Handler for /start command.
+ *
+ * @see https://telegraf.js.org/#/?id=start
+ * @deprecated since v2, use Start decorator instead.
+ */
+export const TelegrafStart = Start;

lib/decorators/telegraf-cashtag.decorator.ts

@@ -1,20 +0,0 @@
-import { SetMetadata } from '@nestjs/common';
-import { DECORATORS } from '../telegraf.constants';
-
-export type TelegrafCashtagCashtag = string | string[];
-
-export interface TelegrafCashtagMetadata {
-  cashtag: TelegrafCashtagCashtag;
-}
-
-/**
- * Cashtag handling.
- * @param cashtag Cashtag
- *
- * https://telegraf.js.org/#/?id=cashtag
- */
-export function TelegrafCashtag(
-  cashtag: TelegrafCashtagCashtag,
-): MethodDecorator {
-  return SetMetadata(DECORATORS.CASHTAG, { cashtag });
-}

lib/decorators/telegraf-command.decorator.ts

@@ -1,20 +0,0 @@
-import { SetMetadata } from '@nestjs/common';
-import { DECORATORS } from '../telegraf.constants';
-
-export type TelegrafCommandCommands = string | string[];
-
-export interface TelegrafCommandMetadata {
-  commands: TelegrafCommandCommands;
-}
-
-/**
- * Command handling.
- * @param commands Commands
- *
- * https://telegraf.js.org/#/?id=command
- */
-export function TelegrafCommand(
-  commands: TelegrafCommandCommands,
-): MethodDecorator {
-  return SetMetadata(DECORATORS.COMMAND, { commands });
-}

lib/decorators/telegraf-entity.decorator.ts

@@ -1,23 +0,0 @@
-import { SetMetadata } from '@nestjs/common';
-import { DECORATORS } from '../telegraf.constants';
-
-export type TelegrafEntityEntity =
-  | string
-  | string[]
-  | RegExp
-  | RegExp[]
-  | Function;
-
-export interface TelegrafEntityMetadata {
-  entity: TelegrafEntityEntity;
-}
-
-/**
- * Entity handling.
- * @param entity Entity name
- *
- * https://telegraf.js.org/#/?id=entity
- */
-export function TelegrafEntity(entity: TelegrafEntityEntity): MethodDecorator {
-  return SetMetadata(DECORATORS.ENTITY, { entity });
-}

lib/decorators/telegraf-game-query.decorator.ts

@@ -1,11 +0,0 @@
-import { SetMetadata } from '@nestjs/common';
-import { DECORATORS } from '../telegraf.constants';
-
-/**
- * Registers middleware for handling callback_data actions with game query.
- *
- * https://telegraf.js.org/#/?id=inlinequery
- */
-export function TelegrafGameQuery(): MethodDecorator {
-  return SetMetadata(DECORATORS.GAME_QUERY, {});
-}

lib/decorators/telegraf-hashtag.decorator.ts

@@ -1,20 +0,0 @@
-import { SetMetadata } from '@nestjs/common';
-import { DECORATORS } from '../telegraf.constants';
-
-export type TelegrafHashtagHashtag = string | string[];
-
-export interface TelegrafHashtagMetadata {
-  hashtag: TelegrafHashtagHashtag;
-}
-
-/**
- * Hashtag handling.
- * @param hashtag Hashtag
- *
- * https://telegraf.js.org/#/?id=hashtag
- */
-export function TelegrafHashtag(
-  hashtag: TelegrafHashtagHashtag,
-): MethodDecorator {
-  return SetMetadata(DECORATORS.HASHTAG, { hashtag });
-}

lib/decorators/telegraf-help.decorator.ts

@@ -1,11 +0,0 @@
-import { SetMetadata } from '@nestjs/common';
-import { DECORATORS } from '../telegraf.constants';
-
-/**
- * Handler for /help command.
- *
- * https://telegraf.js.org/#/?id=help
- */
-export function TelegrafHelp(): MethodDecorator {
-  return SetMetadata(DECORATORS.HELP, {});
-}

lib/decorators/telegraf-mention.decorator.ts

@@ -1,20 +0,0 @@
-import { SetMetadata } from '@nestjs/common';
-import { DECORATORS } from '../telegraf.constants';
-
-export type TelegrafMentionUsername = string | string[];
-
-export interface TelegrafMentionMetadata {
-  username: TelegrafMentionUsername;
-}
-
-/**
- * Mention handling.
- * @param username Username
- *
- * https://telegraf.js.org/#/?id=mention
- */
-export function TelegrafMention(
-  username: TelegrafMentionUsername,
-): MethodDecorator {
-  return SetMetadata(DECORATORS.MENTION, { username });
-}

lib/decorators/telegraf-phone.decorator.ts

@@ -1,18 +0,0 @@
-import { SetMetadata } from '@nestjs/common';
-import { DECORATORS } from '../telegraf.constants';
-
-export type TelegrafPhonePhone = string | string[];
-
-export interface TelegrafPhoneMetadata {
-  phone: TelegrafPhonePhone;
-}
-
-/**
- * Phone number handling.
- * @param phone Phone number
- *
- * https://telegraf.js.org/#/?id=phone
- */
-export function TelegrafPhone(phone: TelegrafPhonePhone): MethodDecorator {
-  return SetMetadata(DECORATORS.PHONE, { phone });
-}

lib/decorators/telegraf-settings.decorator.ts

@@ -1,11 +0,0 @@
-import { SetMetadata } from '@nestjs/common';
-import { DECORATORS } from '../telegraf.constants';
-
-/**
- * Handler for /settings command.
- *
- * https://telegraf.js.org/#/?id=settings
- */
-export function TelegrafSettings(): MethodDecorator {
-  return SetMetadata(DECORATORS.SETTINGS, {});
-}

lib/decorators/telegraf-start.decorator.ts

@@ -1,11 +0,0 @@
-import { SetMetadata } from '@nestjs/common';
-import { DECORATORS } from '../telegraf.constants';
-
-/**
- * Handler for /start command.
- *
- * https://telegraf.js.org/#/?id=start
- */
-export function TelegrafStart(): MethodDecorator {
-  return SetMetadata(DECORATORS.START, {});
-}

lib/decorators/telegraf-use.decorator.ts

@@ -1,11 +0,0 @@
-import { SetMetadata } from '@nestjs/common';
-import { DECORATORS } from '../telegraf.constants';
-
-/**
- * Registers a middleware.
- *
- * https://telegraf.js.org/#/?id=use
- */
-export function TelegrafUse(): MethodDecorator {
-  return SetMetadata(DECORATORS.USE, {});
-}

lib/decorators/use.decorator.ts

@@ -0,0 +1,19 @@
+import { SetMetadata } from '@nestjs/common';
+import { DECORATORS } from '../telegraf.constants';
+
+/**
+ * Registers a middleware.
+ *
+ * @see https://telegraf.js.org/#/?id=use
+ */
+export const Use = (): MethodDecorator => {
+  return SetMetadata(DECORATORS.USE, {});
+};
+
+/**
+ * Registers a middleware.
+ *
+ * @see https://telegraf.js.org/#/?id=use
+ * @deprecated since v2, use Use decorator instead.
+ */
+export const TelegrafUse = Use;