feat: about scene

LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2024 dodyagung.com
+
+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.

src/sale/sale.common.ts

@@ -16,18 +16,13 @@ const extra = (keyboard: HideableIKBtn[][]): ExtraEditMessageText => {
   };
 };
 
-export const editMessage = async (
-  ctx: SceneContext,
-  message: string,
-  keyboard: HideableIKBtn[][],
-): Promise<void> => {
-  await ctx.editMessageText(message, extra(keyboard));
-};
-
 export const sendMessage = async (
   ctx: SceneContext,
   message: string,
   keyboard: HideableIKBtn[][],
+  new_message: boolean = false,
 ): Promise<void> => {
-  await ctx.reply(message, extra(keyboard));
+  (await new_message)
+    ? ctx.reply(message, extra(keyboard))
+    : ctx.editMessageText(message, extra(keyboard));
 };

src/sale/sale.module.ts

@@ -5,9 +5,10 @@ import { ConfigModule } from '@nestjs/config';
 import { SaleService } from './sale.service';
 import { SaleScene } from './scene/sale.scene';
 import { WelcomeScene } from './scene/welcome.scene';
+import { AboutScene } from './scene/about.scene';
 
 @Module({
-  providers: [SaleUpdate, SaleService, SaleScene, WelcomeScene],
+  providers: [SaleUpdate, SaleService, SaleScene, WelcomeScene, AboutScene],
   imports: [ConfigModule, PrismaModule],
 })
 export class SaleModule {}

src/sale/scene/about.scene.ts

@@ -0,0 +1,38 @@
+import { Scene, SceneEnter, Ctx, Action } from 'nestjs-telegraf';
+import { SceneContext } from 'telegraf/scenes';
+import { Markup } from 'telegraf';
+import { sendMessage } from '../sale.common';
+
+@Scene('ABOUT_SCENE')
+export class AboutScene {
+  @SceneEnter()
+  async onSceneEnter(@Ctx() ctx: SceneContext): Promise<void> {
+    const keyboard = [[Markup.button.callback('🔙 Back', 'back')]];
+
+    let message = `*🤖 About*\n\n`;
+    message += `*telegram\\-sale\\-bot*\n`;
+    message += `I\\'m a bot to automate your scheduled\\-sale in Telegram group\\.\n`;
+    message += `Open\\-sourced at [GitHub](https://github.com/dodyagung/telegram-sale-bot)\\. Built with [NestJS](https://nestjs.com) and [Telegraf](https://telegraf.js.org)\\.\n`;
+    message += `Made with ♥ in Jakarta, Indonesia\\.\n\n`;
+
+    message += `*Contact Us*\n`;
+    message += `Found an error? Have a question? Open a [GitHub Issues](https://github.com/dodyagung/telegram-sale-bot/issues)\\.\n\n`;
+
+    message += `*Contribute*\n`;
+    message += `If you are developer, open a [GitHub Pull Request](https://github.com/dodyagung/telegram-sale-bot/pulls)\\.\n\n`;
+
+    message += `*Creator*\n`;
+    message += `Hi, I am Dody\\. A backend enthusiast\\. Loves Golang and Typescript\\.\n`;
+    message += `Visit my website at [dodyagung\\.com](https://dodyagung.com)\\.\n\n`;
+
+    message += `*License*\n`;
+    message += `This open\\-source project is licensed under [MIT license](https://github.com/dodyagung/telegram-sale-bot/blob/master/LICENSE.md)\\.`;
+
+    await sendMessage(ctx, message, keyboard);
+  }
+
+  @Action('back')
+  async onBack(@Ctx() ctx: SceneContext): Promise<void> {
+    await ctx.scene.enter('WELCOME_SCENE');
+  }
+}

src/sale/scene/sale.scene.ts

@@ -1,19 +1,16 @@
 import { Scene, SceneEnter, Ctx, Action } from 'nestjs-telegraf';
 import { SceneContext } from 'telegraf/scenes';
 import { Markup } from 'telegraf';
-import { SaleUpdate } from '../sale.update';
-import { editMessage } from '../sale.common';
+import { sendMessage } from '../sale.common';
 
 @Scene('SALE_SCENE')
 export class SaleScene {
-  constructor(private saleUpdate: SaleUpdate) {}
-
   @SceneEnter()
   async onSceneEnter(@Ctx() ctx: SceneContext): Promise<void> {
     const keyboard = [[Markup.button.callback('🔙 Back', 'back')]];
     const message = ' sale scene';
 
-    await editMessage(ctx, message, keyboard);
+    await sendMessage(ctx, message, keyboard);
   }
 
   @Action('back')

src/sale/scene/welcome.scene.ts

@@ -3,7 +3,7 @@ import { SceneContext } from 'telegraf/scenes';
 import { Markup } from 'telegraf';
 import { ConfigService } from '@nestjs/config';
 import { RESET_DAY, SALE_DAY, TIMEZONE, TODAY } from '../sale.constant';
-import { editMessage, sendMessage } from '../sale.common';
+import { sendMessage } from '../sale.common';
 
 @Scene('WELCOME_SCENE')
 export class WelcomeScene {
@@ -52,15 +52,16 @@ export class WelcomeScene {
     message += `├ Joined : \`${user_joined ? 'Yes' : 'No'}\`\n`;
     message += `└ Link : [Click Here](${this.configService.get<string>('TELEGRAM_GROUP_LINK')})`;
 
-    if (ctx.callbackQuery) {
-      await editMessage(ctx, message, keyboard);
-    } else {
-      await sendMessage(ctx, message, keyboard);
-    }
+    await sendMessage(ctx, message, keyboard, !ctx.callbackQuery);
   }
 
   @Action('sale')
   async onSaleAction(@Ctx() ctx: SceneContext): Promise<void> {
     await ctx.scene.enter('SALE_SCENE');
   }
+
+  @Action('about')
+  async onAboutAction(@Ctx() ctx: SceneContext): Promise<void> {
+    await ctx.scene.enter('ABOUT_SCENE');
+  }
 }