create-gramstax 0.1.0 → 0.1.1

package/LICENSE

@@ -1,25 +1,25 @@
-MIT License (with Fair Donation Clause)
-
-Copyright (c) 2025 Gramstax
-
-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 condition:
-
-If this Software is used in any commercial, revenue-generating, or
-client-based project (including freelance, agency, or product development),
-users are encouraged—but not legally required—to make a fair donation
-to support the ongoing development and maintenance of this Software.
-
-Donations can be made through: [your donation link here]
-
-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.
+MIT License (with Fair Donation Clause)
+
+Copyright (c) 2025 Gramstax
+
+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 condition:
+
+If this Software is used in any commercial, revenue-generating, or
+client-based project (including freelance, agency, or product development),
+users are encouraged—but not legally required—to make a fair donation
+to support the ongoing development and maintenance of this Software.
+
+Donations can be made through: [your donation link here]
+
+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.

package/dist/src/templates/.env.example

@@ -1,15 +1,15 @@
-# Telegram Bot Token
-BOT_TOKEN=your_bot_token_here
-
-# Bot Deployment Mode
-# Options: 
-#   - polling
-#   - webhook:<full-public-url> | example: webhook:https://yourdomain.com/telegram-webhook
-#   - serverless:<adapter> | example: serverless:std/http
-BOT_DEPLOY=polling
-
-# Cache configuration for session
-# Options: 
-#   - memory
-#   - redis:<url> | example: redis://127.0.0.1:6379
+# Telegram Bot Token
+BOT_TOKEN=your_bot_token_here
+
+# Bot Deployment Mode
+# Options: 
+#   - polling
+#   - webhook:<full-public-url> | example: webhook:https://yourdomain.com/telegram-webhook
+#   - serverless:<adapter> | example: serverless:std/http
+BOT_DEPLOY=polling
+
+# Cache configuration for session
+# Options: 
+#   - memory
+#   - redis:<url> | example: redis://127.0.0.1:6379
 CACHE_SESSION=memory

package/dist/src/templates/.prettierrc

@@ -1,23 +1,23 @@
-{
-  "overrides": [
-    {
-      "files": "*.{json,sol}",
-      "options": {
-        "tabWidth": 2,
-        "printWidth": 200
-      }
-    },
-    {
-      "files": "*.{ts,js}",
-      "options": {
-        "printWidth": 300,
-        "tabWidth": 2,
-        "useTabs": false,
-        "semi": false,
-        "arrowParens": "always",
-        "trailingComma": "none",
-        "bracketSameLine": false
-      }
-    }
-  ]
-}
+{
+  "overrides": [
+    {
+      "files": "*.{json,sol}",
+      "options": {
+        "tabWidth": 2,
+        "printWidth": 200
+      }
+    },
+    {
+      "files": "*.{ts,js}",
+      "options": {
+        "printWidth": 300,
+        "tabWidth": 2,
+        "useTabs": false,
+        "semi": false,
+        "arrowParens": "always",
+        "trailingComma": "none",
+        "bracketSameLine": false
+      }
+    }
+  ]
+}

package/dist/src/templates/README.md

@@ -1,120 +1,120 @@
-# {{projectName}}
-
-A Telegram bot built with Gramstax framework.
-
-## Getting Started
-
-### Development
-
-1. Install dependencies:
-
-```bash
-{{installCmd}}
-```
-
-2. Set up your environment variables:
-
-Copy `.env.example` to `.env` and add your Telegram bot token:
-
-```bash
-BOT_TOKEN=your_bot_token_here
-```
-
-3. Run the development server:
-
-```bash
-{{runDevCmd}}
-```
-
-### Production
-
-#### Using PM2 (Recommended)
-
-PM2 is a production process manager for Node.js applications with built-in load balancer.
-
-1. Install dependencies:
-
-```bash
-{{installCmd}}
-```
-
-2. Set up production environment:
-
-```bash
-cp .env.example .env
-# Edit .env with your production BOT_TOKEN
-```
-
-3. Start with PM2:
-
-```bash
-{{runPm2StartCmd}}
-```
-
-4. PM2 Management Commands:
-
-```bash
-# View logs
-{{runPm2LogsCmd}}
-
-# Monitor processes
-{{runPm2MonitCmd}}
-
-# Restart bot
-{{runPm2RestartCmd}}
-
-# Stop bot
-{{runPm2StopCmd}}
-
-# Delete from PM2
-{{runPm2DeleteCmd}}
-```
-
-5. Setup PM2 to start on system boot:
-
-```bash
-pm2 startup
-pm2 save
-```
-
-#### Using Bun directly
-
-```bash
-{{runStartCmd}}
-```
-
-## Project Structure
-
-- `src/base/` - Base classes for your bot components
-- `src/core/` - Core bot configuration and hooks
-- `src/pages/` - Bot pages/screens
-- `src/guards/` - Route guards and middleware
-- `src/services/` - Business logic services
-- `src/repositories/` - Data access layer
-- `src/templates/` - Message templates
-- `src/utils/` - Utility functions
-- `logs/` - Application logs (created automatically)
-
-## Configuration
-
-### Environment Variables
-
-- `BOT_TOKEN` - Your Telegram bot token (required)
-- `CACHE_SESSION` - Cache type configuration (optional)
-
-### PM2 Configuration
-
-The `ecosystem.config.js` file contains PM2 configuration:
-
-- **instances**: Number of instances (default: 1)
-- **exec_mode**: Execution mode (cluster/fork)
-- **max_memory_restart**: Auto-restart if memory exceeds limit
-- **autorestart**: Auto-restart on crash
-- **error_file/out_file**: Log file locations
-
-## Learn More
-
-- [Gramstax Documentation](https://github.com/gramstax/gramstax)
-- [Grammy Documentation](https://grammy.dev/)
-- [Telegram Bot API](https://core.telegram.org/bots/api)
-- [PM2 Documentation](https://pm2.keymetrics.io/)
+# {{projectName}}
+
+A Telegram bot built with Gramstax framework.
+
+## Getting Started
+
+### Development
+
+1. Install dependencies:
+
+```bash
+{{installCmd}}
+```
+
+2. Set up your environment variables:
+
+Copy `.env.example` to `.env` and add your Telegram bot token:
+
+```bash
+BOT_TOKEN=your_bot_token_here
+```
+
+3. Run the development server:
+
+```bash
+{{runDevCmd}}
+```
+
+### Production
+
+#### Using PM2 (Recommended)
+
+PM2 is a production process manager for Node.js applications with built-in load balancer.
+
+1. Install dependencies:
+
+```bash
+{{installCmd}}
+```
+
+2. Set up production environment:
+
+```bash
+cp .env.example .env
+# Edit .env with your production BOT_TOKEN
+```
+
+3. Start with PM2:
+
+```bash
+{{runPm2StartCmd}}
+```
+
+4. PM2 Management Commands:
+
+```bash
+# View logs
+{{runPm2LogsCmd}}
+
+# Monitor processes
+{{runPm2MonitCmd}}
+
+# Restart bot
+{{runPm2RestartCmd}}
+
+# Stop bot
+{{runPm2StopCmd}}
+
+# Delete from PM2
+{{runPm2DeleteCmd}}
+```
+
+5. Setup PM2 to start on system boot:
+
+```bash
+pm2 startup
+pm2 save
+```
+
+#### Using Bun directly
+
+```bash
+{{runStartCmd}}
+```
+
+## Project Structure
+
+- `src/base/` - Base classes for your bot components
+- `src/core/` - Core bot configuration and hooks
+- `src/pages/` - Bot pages/screens
+- `src/guards/` - Route guards and middleware
+- `src/services/` - Business logic services
+- `src/repositories/` - Data access layer
+- `src/templates/` - Message templates
+- `src/utils/` - Utility functions
+- `logs/` - Application logs (created automatically)
+
+## Configuration
+
+### Environment Variables
+
+- `BOT_TOKEN` - Your Telegram bot token (required)
+- `CACHE_SESSION` - Cache type configuration (optional)
+
+### PM2 Configuration
+
+The `ecosystem.config.js` file contains PM2 configuration:
+
+- **instances**: Number of instances (default: 1)
+- **exec_mode**: Execution mode (cluster/fork)
+- **max_memory_restart**: Auto-restart if memory exceeds limit
+- **autorestart**: Auto-restart on crash
+- **error_file/out_file**: Log file locations
+
+## Learn More
+
+- [Gramstax Documentation](https://github.com/gramstax/gramstax)
+- [Grammy Documentation](https://grammy.dev/)
+- [Telegram Bot API](https://core.telegram.org/bots/api)
+- [PM2 Documentation](https://pm2.keymetrics.io/)

package/dist/src/templates/bunfig.toml

@@ -1,2 +1,2 @@
-[run]
+[run]
 console.depth = 4

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

@@ -1,11 +1,11 @@
-import { CtxCore } from "~/core"
-
-export abstract class GuardBase extends CtxCore {
-  public constructor(ctx: CtxCore) {
-    super(ctx)
-    if (ctx?.data) {
-      // save as temporary because guard should not save this.data or class.data because it is intended for Page only.
-      this.temp.data = ctx.data
-    }
-  }
-}
+import { CtxCore } from "~/core"
+
+export abstract class GuardBase extends CtxCore {
+  public constructor(ctx: CtxCore) {
+    super(ctx)
+    if (ctx?.data) {
+      // save as temporary because guard should not save this.data or class.data because it is intended for Page only.
+      this.temp.data = ctx.data
+    }
+  }
+}

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

@@ -1,4 +1,4 @@
-export * from "./guard"
-export * from "./page"
-export * from "./repository"
-export * from "./service"
+export * from "./guard"
+export * from "./page"
+export * from "./repository"
+export * from "./service"

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

@@ -1,3 +1,3 @@
-import { CtxCore } from "~/core"
-
-export abstract class PageBase extends CtxCore {}
+import { CtxCore } from "~/core"
+
+export abstract class PageBase extends CtxCore {}

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

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

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

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

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

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

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

@@ -1,3 +1,3 @@
-import { Ctx } from "gramstax"
-
-export class CtxCore extends Ctx {}
+import { Ctx } from "gramstax"
+
+export class CtxCore extends Ctx {}

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

@@ -1,2 +1,2 @@
-export * from "./bot"
-export * from "./ctx"
+export * from "./bot"
+export * from "./ctx"

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

@@ -1 +1 @@
-export class Db {}
+export class Db {}

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

@@ -1,5 +1,5 @@
-export const env = {
-  BOT_TOKEN: process.env.BOT_TOKEN as string,
-  BOT_DEPLOY: process.env.BOT_DEPLOY as string,
-  CACHE_SESSION: process.env.CACHE_SESSION as string
-}
+export const env = {
+  BOT_TOKEN: process.env.BOT_TOKEN as string,
+  BOT_DEPLOY: process.env.BOT_DEPLOY as string,
+  CACHE_SESSION: process.env.CACHE_SESSION as string
+}

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

@@ -1 +1 @@
-export * from "./user"
+export * from "./user"

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

@@ -1,19 +1,19 @@
-import { GuardBase } from "~/base"
-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
-    }
-  }
-}
+import { GuardBase } from "~/base"
+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

@@ -1,15 +1,15 @@
-import { env } from "./env"
-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..`)
-
-  new BotCore({
-    token: env.BOT_TOKEN,
-    deploy: env.BOT_DEPLOY,
-    cacheSession: new CacheExternal(env.CACHE_SESSION, `session`, 24 * 60 * 60 * 1000)
-  })
-})
+import { env } from "./env"
+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..`)
+
+  new BotCore({
+    token: env.BOT_TOKEN,
+    deploy: env.BOT_DEPLOY,
+    cacheSession: new CacheExternal(env.CACHE_SESSION, `session`, 24 * 60 * 60 * 1000)
+  })
+})

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

@@ -1,28 +1,28 @@
-import { PageBase } from "~/base"
-import { StartPage } from "./start"
-
-export class GeneralErrorInputNotFoundPage extends PageBase {
-  public kb() {
-    return this.inlineKeyboard((kb, arr) => {
-      return kb.text(arr[0]!, StartPage.data.callbackData())
-    })
-  }
-
-  public async transition() {
-    await this.edit(this.kb())
-  }
-
-  public static template = /*jsx*/ `
-    <base>
-      <keyboard type="inline">.. Home</keyboard>
-      <keyboard lang="en" type="inline">.. Home</keyboard>
-      <keyboard lang="it" type="inline">.. Casa</keyboard>
-      <keyboard lang="id" type="inline">.. Beranda</keyboard>
-
-      <message><b>❌ Not Found</b></message>
-      <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>
-  `
-}
+import { PageBase } from "~/base"
+import { StartPage } from "./start"
+
+export class GeneralErrorInputNotFoundPage extends PageBase {
+  public kb() {
+    return this.inlineKeyboard((kb, arr) => {
+      return kb.text(arr[0]!, StartPage.data.callbackData())
+    })
+  }
+
+  public async transition() {
+    await this.edit(this.kb())
+  }
+
+  public static template = /*jsx*/ `
+    <base>
+      <keyboard type="inline">.. Home</keyboard>
+      <keyboard lang="en" type="inline">.. Home</keyboard>
+      <keyboard lang="it" type="inline">.. Casa</keyboard>
+      <keyboard lang="id" type="inline">.. Beranda</keyboard>
+
+      <message><b>❌ Not Found</b></message>
+      <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>
+  `
+}