create-gramstax 0.0.1

package/dist/src/templates/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "{{projectName}}",
+  "version": "0.1.0",
+  "private": true,
+  "description": "",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": ""
+  },
+  "bugs": {
+    "url": ""
+  },
+  "homepage": "",
+  "author": "",
+  "license": "MIT",
+  "main": "./dist/src/index.js",
+  "types": "./dist/src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "import": "./dist/src/index.js",
+      "default": "./dist/src/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "scripts": {
+    "dev": "bun --watch src/index.ts",
+    "start": "bun src/index.ts",
+    "build": "bun build src/index.ts --outdir dist --target bun",
+    "lint": "eslint '**/*.ts'",
+    "lint:fix": "eslint '**/*.ts' --fix",
+    "pm2:start": "pm2 start ecosystem.config.cjs",
+    "pm2:stop": "pm2 stop ecosystem.config.cjs",
+    "pm2:restart": "pm2 restart ecosystem.config.cjs",
+    "pm2:delete": "pm2 delete ecosystem.config.cjs",
+    "pm2:logs": "pm2 logs",
+    "pm2:monit": "pm2 monit"
+  },
+  "dependencies": {
+    "gramstax": "latest",
+    "grammy": "^1.38.3",
+    "logging-pretty": "^3.0.0"
+  },
+  "peerDependencies": {
+    "typescript": "latest"
+  },
+  "devDependencies": {
+    "@types/bun": "latest",
+    "pm2": "^5.3.0"
+  }
+}

package/dist/src/templates/src/base/general.ts

@@ -0,0 +1,3 @@
+import { BaseGeneral } from "gramstax"
+
+export abstract class GeneralBase extends BaseGeneral {}

package/dist/src/templates/src/base/guard.ts

@@ -0,0 +1,3 @@
+import { BaseGuard } from "gramstax"
+
+export abstract class GuardBase extends BaseGuard {}

package/dist/src/templates/src/base/page.ts

@@ -0,0 +1,3 @@
+import { BasePage } from "gramstax"
+
+export abstract class PageBase extends BasePage {}

package/dist/src/templates/src/base/repository.ts

@@ -0,0 +1 @@
+export abstract class RepositoryBase {}

package/dist/src/templates/src/base/service.ts

@@ -0,0 +1 @@
+export abstract class ServiceBase {}

package/dist/src/templates/src/core/bot.ts

@@ -0,0 +1,22 @@
+import { Gramstax, type Ctx } from "gramstax"
+import { UserGuard } from "../guards/user"
+import { GeneralErrorPage } from "../pages/general-error"
+import { GeneralErrorInputNotFoundPage } from "../pages/general-error-input-notfound"
+
+export class BotCore extends Gramstax {
+  public async hookBeforeRoute(ctx: Ctx): Promise<boolean> {
+    const result = await new UserGuard({ ctx }).ensureValid(true)
+    if (result === null) {
+      return false
+    }
+    return true
+  }
+
+  public async hookErrorPage(ctx: Ctx, listenerName: string, error: any, isEdit: boolean): Promise<void> {
+    await new GeneralErrorPage(ctx).transition(this.constructor.name, listenerName, error, isEdit)
+  }
+
+  public async hookErrorInputNotFoundPage(ctx: Ctx): Promise<void> {
+    await new GeneralErrorInputNotFoundPage(ctx).transition()
+  }
+}

package/dist/src/templates/src/db/index.ts

@@ -0,0 +1,3 @@
+// YOU CAN DELETE THIS FILE
+
+export class Db {}

package/dist/src/templates/src/env.d.ts

@@ -0,0 +1,8 @@
+declare namespace NodeJS {
+  interface ProcessEnv {
+    BOT_TOKEN: string
+    BOT_DEPLOY: string
+    NODE_ENV?: `development` | `production`
+    CACHE_SESSION?: string
+  }
+}

package/dist/src/templates/src/guards/user.ts

@@ -0,0 +1,19 @@
+import { GuardBase } from "../base/guard"
+import { GeneralErrorPage } from "../pages/general-error"
+import { UserNameNotFoundPage } from "../pages/username-notfound"
+
+export class UserGuard extends GuardBase {
+  public async ensureValid(isEdit: boolean) {
+    try {
+      if (!this.username || this.username.length == 0) {
+        await new UserNameNotFoundPage(this).transition(isEdit)
+        return null
+      }
+
+      return { status: true }
+    } catch (err) {
+      await new GeneralErrorPage(this).transition(this.constructor.name, `ensureValid`, err, isEdit)
+      return null
+    }
+  }
+}

package/dist/src/templates/src/index.ts

@@ -0,0 +1,17 @@
+import { log } from "./utils/log"
+import { BotCore } from "./core/bot"
+import { MainThread } from "./threads/main"
+import { CacheExternal } from "gramstax"
+
+new MainThread(() => {
+  log.success(`Bot started..`)
+
+  const token = process.env.BOT_TOKEN as string
+  const deploy = process.env.BOT_DEPLOY as string
+  const cache = process.env.CACHE_SESSION as string
+  new BotCore({
+    token,
+    deploy,
+    cacheSession: new CacheExternal(cache, `session`, 24 * 60 * 60 * 1000)
+  })
+})

package/dist/src/templates/src/pages/general-error-input-notfound.ts

@@ -0,0 +1,34 @@
+import { PageBase } from "../base/page"
+import { StartPage } from "./start"
+
+export class GeneralErrorInputNotFoundPage extends PageBase {
+  public kb() {
+    return this.buildInlineKeyboard((kb, arr) => {
+      return kb.text(arr[0], StartPage.data.callbackData())
+    })
+  }
+
+  public async transition() {
+    await this.edit(this.kb())
+  }
+
+  public static template = /*jsx*/ `
+    <base>
+      <keyboard lang="en" for="inline">.. Home</keyboard>
+      <keyboard lang="it" for="inline">.. Casa</keyboard>
+      <keyboard lang="id" for="inline">.. Beranda</keyboard>
+
+      <message lang="en">
+        <b>❌ Not Found</b>
+      </message>
+
+      <message lang="it">
+        <b>❌ Non Trovato</b>
+      </message>
+
+      <message lang="id">
+        <b>❌ Tidak Ditemukan</b>
+      </message>
+    </base>
+  `
+}

package/dist/src/templates/src/pages/general-error.ts

@@ -0,0 +1,51 @@
+import { PageBase } from "../base/page"
+import { StartPage } from "./start"
+
+export class GeneralErrorPage extends PageBase {
+  public kb() {
+    return this.buildInlineKeyboard((kb, arr) => {
+      return kb.text(arr[0], StartPage.data.callbackData())
+    })
+  }
+
+  public async transition(constructorName: string, funcName: string, error: any, isUpdate = true) {
+    this.logError(error, constructorName, funcName)
+    await this.sessionClear()
+
+    const kb = this.kb()
+    if (isUpdate === true) {
+      await this.edit(kb)
+    } else {
+      await this.reply(kb)
+    }
+  }
+
+  public static template = /*jsx*/ `
+    <base>
+      <keyboard lang="en" for="inline">.. Home</keyboard>
+      <keyboard lang="es" for="inline">.. Inicio</keyboard>
+      <keyboard lang="id" for="inline">.. Beranda</keyboard>
+
+      <message lang="en">
+        <b>❌ Error</b>
+
+        An unexpected error occurred.
+        Please try again later.
+      </message>
+
+      <message lang="it">
+        <b>❌ Errore</b>
+
+        Si è verificato un errore imprevisto.
+        Riprova più tardi.
+      </message>
+
+      <message lang="id">
+        <b>❌ Kesalahan</b>
+
+        Terjadi kesalahan yang tidak diharapkan.
+        Silakan coba lagi nanti.
+      </message>
+    </base>
+  `
+}

package/dist/src/templates/src/pages/help.ts

@@ -0,0 +1,56 @@
+import { PageBase } from "../base/page"
+import { StartPage } from "./start"
+
+export class HelpPage extends PageBase {
+  public kb() {
+    return this.buildInlineKeyboard((kb, arr) => {
+      return kb //
+        .text(arr[0], StartPage.data.callbackData())
+    })
+  }
+
+  public async internal(edit = true) {
+    const kb = this.kb()
+    if (edit) {
+      await this.edit(kb)
+    } else {
+      await this.reply(kb)
+    }
+  }
+
+  public async callback() {
+    await this.internal(true)
+  }
+
+  public async text() {
+    await this.internal(false)
+  }
+
+  public async textCommand() {
+    await this.internal(false)
+  }
+
+  public async textCommandPayload() {
+    await this.internal(false)
+  }
+
+  public static template = /*jsx*/ `
+    <base>
+      <keyboard lang="en" for="inline">.. Back</keyboard>
+      <keyboard lang="it" for="inline">.. Ritorno</keyboard>
+      <keyboard lang="id" for="inline">.. Kembali</keyboard>
+
+      <message lang="en">
+        <b>Help message</b>
+      </message>
+
+      <message lang="it">
+        <b>Ordina aiuto</b>
+      </message>
+
+      <message lang="id">
+        <b>Pesan bantuan</b>
+      </message>
+    </base>
+  `
+}

package/dist/src/templates/src/pages/start.ts

@@ -0,0 +1,63 @@
+import { HelpPage } from "./help"
+import { PageBase } from "../base/page"
+
+export class StartPage extends PageBase {
+  public kb() {
+    return this.buildInlineKeyboard((kb, arr) => {
+      return kb //
+        .text(arr[0], HelpPage.data.callbackData())
+    })
+  }
+
+  public async internal(edit = true) {
+    const kb = this.kb()
+    const data = { username: this.ctx.username }
+    if (edit) {
+      await this.edit(kb, data)
+    } else {
+      await this.reply(kb, data)
+    }
+  }
+
+  public async callback() {
+    await this.internal(true)
+  }
+
+  public async text() {
+    await this.internal(false)
+  }
+
+  public async textCommand() {
+    await this.internal(false)
+  }
+
+  public async textCommandPayload() {
+    await this.internal(false)
+  }
+
+  public static template = /*jsx*/ `
+    <base>
+      <keyboard lang="en" for="inline">❓ Help</keyboard>
+      <keyboard lang="it" for="inline">❓ Aiuto</keyboard>
+      <keyboard lang="id" for="inline">❓ Bantuan</keyboard>
+
+      <message lang="en">
+        <b>Welcome to the bot {{username}}</b>
+
+        <b>❓ Help</b> - View help
+      </message>
+
+      <message lang="it">
+        <b>Benvenuto nel Bot di {{username}}</b>
+
+        <b>❓ Aiuto</b> - Ottieni assistenza e informazioni
+      </message>
+
+      <message lang="id">
+        <b>Selamat datang di bot {{username}}</b>
+
+        <b>❓ Bantuan</b> - Lihat bantuan
+      </message>
+    </base>
+  `
+}

package/dist/src/templates/src/pages/username-notfound.ts

@@ -0,0 +1,41 @@
+import { HelpPage } from "./help"
+import { PageBase } from "../base/page"
+
+export class UserNameNotFoundPage extends PageBase {
+  public kb() {
+    return this.buildInlineKeyboard((kb, arr) => {
+      return kb //
+        .text(arr[0], HelpPage.data.callbackData())
+    })
+  }
+
+  public async transition(edit = true) {
+    const kb = this.kb()
+    const data = { username: this.ctx.username }
+    if (edit) {
+      await this.edit(kb, data)
+    } else {
+      await this.reply(kb, data)
+    }
+  }
+
+  public static template = /*jsx*/ `
+    <base>
+      <keyboard lang="en" for="inline">.. Home</keyboard>
+      <keyboard lang="es" for="inline">.. Inicio</keyboard>
+      <keyboard lang="id" for="inline">.. Beranda</keyboard>
+
+      <message lang="en">
+        Please set the username first before using the bot.
+      </message>
+
+      <message lang="it">
+        Prima di utilizzare il bot, imposta prima il nome utente.
+      </message>
+
+      <message lang="id">
+        Tolong set username dulu sebelum memakai bot
+      </message>
+    </base>
+  `
+}

package/dist/src/templates/src/repositories/example.ts

@@ -0,0 +1,5 @@
+// YOU CAN DELETE THIS FILE
+
+import { RepositoryBase } from "../base/repository"
+
+export class ExampleRepository extends RepositoryBase {}

package/dist/src/templates/src/services/example.ts

@@ -0,0 +1,4 @@
+// YOU CAN DELETE THIS FILE
+import { ServiceBase } from "../base/service"
+
+export class ExampleService extends ServiceBase {}

package/dist/src/templates/src/templates/example.html

@@ -0,0 +1,7 @@
+<!-- YOU CAN DELETE THIS FILE -->
+
+<base>
+<message lang="en">
+    Must have file page in /pages/example.ts
+</message>
+</base>

package/dist/src/templates/src/threads/main.ts

@@ -0,0 +1,9 @@
+import { isMainThread } from "bun"
+
+export class MainThread {
+  constructor(mainFunc: () => any) {
+    if (isMainThread === true) {
+      mainFunc()
+    }
+  }
+}

package/dist/src/templates/src/utils/log.ts

@@ -0,0 +1,3 @@
+import LoggingPretty from "logging-pretty"
+
+export const log = new LoggingPretty()

package/dist/src/templates/tsconfig.json

@@ -0,0 +1,38 @@
+{
+  "compilerOptions": {
+    // Short relative path
+    "baseUrl": ".",
+    "paths": {
+      "~/*": [
+        "./src/*"
+      ]
+    },
+    // Environment setup & latest features
+    "lib": [
+      "ESNext"
+    ],
+    "target": "ESNext",
+    "module": "Preserve",
+    "moduleDetection": "force",
+    "types": [
+      "bun-types"
+    ],
+    "jsx": "react-jsx",
+    "allowJs": true,
+    // Bundler mode
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "noEmit": true,
+    // Best practices
+    "strict": true,
+    "skipLibCheck": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedIndexedAccess": true,
+    // Some stricter flags (disabled by default)
+    "noImplicitOverride": true,
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "noPropertyAccessFromIndexSignature": false,
+  }
+}

package/dist/src/utils/logger.d.ts

@@ -0,0 +1,3 @@
+import LoggingPretty from "logging-pretty";
+export declare const log: LoggingPretty;
+//# sourceMappingURL=logger.d.ts.map

package/dist/src/utils/logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../../src/utils/logger.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,gBAAgB,CAAA;AAE1C,eAAO,MAAM,GAAG,eAAsB,CAAA"}

package/dist/src/utils/logger.js

@@ -0,0 +1,2 @@
+import LoggingPretty from "logging-pretty";
+export const log = new LoggingPretty();

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "create-gramstax",
+  "version": "0.0.1",
+  "private": false,
+  "description": "CLI tool to quickly create a new Gramstax Telegram bot project with all the best practices",
+  "keywords": [
+    "create-gramstax",
+    "gramstax",
+    "telegram",
+    "bot",
+    "cli",
+    "generator",
+    "scaffold",
+    "telegram-bot"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/gramstax/gramstax",
+    "directory": "packages/create-gramstax"
+  },
+  "bugs": {
+    "url": "https://github.com/gramstax/gramstax/issues"
+  },
+  "homepage": "https://github.com/gramstax/gramstax",
+  "author": "gramstax",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/src/index.js",
+  "types": "./dist/src/index.d.ts",
+  "bin": {
+    "create-gramstax": "./dist/src/index.js"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "import": "./dist/src/index.js",
+      "default": "./dist/src/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "devDependencies": {
+    "@types/bun": "latest"
+  },
+  "peerDependencies": {
+    "typescript": "^5"
+  },
+  "dependencies": {
+    "commander": "^14.0.2",
+    "enquirer": "^2.4.1",
+    "gramstax": "workspace:*",
+    "logging-pretty": "^3.0.0"
+  }
+}