@ahmadjavaiddev/aura 1.0.1 → 1.0.2

package/README.md

@@ -1,98 +1,105 @@
-# 🚀 Aura
+# Aura
 
-**Aura** is a powerful, interactive CLI scaffolder designed to generate modern, high-performance Express.js backends in seconds. It abstracts away the boilerplate while giving you full control over the features you actually need.
+**The High-Performance API Scaffolder.**  
+Aura is an interactive CLI designed for developers who want to build modern Express.js backends—without the boilerplate. It abstracts framework complexities into a dedicated core while giving you total control over the features you need.
 
-Built for speed with **Bun** and **TypeScript**, Aura ensures your project starts with a solid, type-safe foundation.
+[![npm version](https://img.shields.io/npm/v/@ahmadjavaiddev/aura.svg?style=flat-square)](https://www.npmjs.com/package/@ahmadjavaiddev/aura)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square)](https://opensource.org/licenses/MIT)
 
-[![npm version](https://img.shields.io/npm/v/@ahmadjavaiddev/aura.svg)](https://www.npmjs.com/package/@ahmadjavaiddev/aura)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+---
+
+## Why Aura?
+
+- **Zero Boilerplate**: Skip the setup. Get a production-ready API in 30 seconds.
+- **Abstraction-First**: Your logic in `src/routes`, framework magic in `src/base`.
+- **Full-Type Safety**: Built from the ground up with TypeScript and Zod.
+- **Enterprise-Ready**: Built-in support for OpenTelemetry, Redis, Auth, and Inngest.
+
+---
 
-## 📦 Installation & Usage
+## Quick Start
 
-You can run Aura directly without installing it globally using `npx`:
+Start your next project immediately with `npx`:
 
 ```bash
 npx @ahmadjavaiddev/aura my-new-project
 ```
 
 ### Options
-- `my-new-project`: The name of the directory to create.
-- `--version`, `-v`: Show version number.
-- `--help`, `-h`: Show help information.
+| Command | Description |
+| :--- | :--- |
+| `aura [name]` | Create a new project in the specified directory |
+| `-v, --version` | Display current Aura version |
+| `-h, --help` | Show usage information |
 
-## ✨ Features
+---
+
+## Pick Your Stack
 
-Aura is highly modular. During the interactive setup, you can pick and choose from the following:
+Aura is modular by design. Select only the components you need for your project:
 
-- 🗄️ **Database ORMs**: Prisma (PostgreSQL), Drizzle (PostgreSQL), or Mongoose (MongoDB).
-- 🔐 **Authentication**: Clerk (Hosted), Better-Auth (Self-hosted), or a Custom JWT Middleware starter.
-- ⚡ **Caching**: Distributed caching with Redis or simple In-memory local caching.
-- 🪵 **Logging**: Advanced OpenTelemetry (with PostHog integration) or standard Console logging.
-- 🚥 **Rate Limiting**: Redis-based (distributed) or Basic (memory-based) protection.
-- 📨 **Emails**: Integration with Resend or traditional SMTP via Nodemailer.
-- 🔄 **Background Jobs**: Built-in support for Inngest event-driven background functions.
-- 📏 **Linting & Formatting**: Biome (Ultra-fast) or the classic Prettier + ESLint combo.
-- 📄 **Pagination**: Pre-configured Zod schemas and pagination helpers.
+### Database & Models
+- **ORM Options**: Prisma (PostgreSQL), Drizzle (SQL), Mongoose (MongoDB).
+- **Auto-Sync**: Pre-configured scripts for database migrations and client generation.
 
-## 🏗️ Project Structure
+### Security & Auth
+- **Providers**: Clerk (Hosted), Better-Auth (Self-hosted), Custom JWT.
+- **Protection**: Optional Redis-based Rate Limiting and Role-based access skeletons.
 
-Aura follows a clean, "Abstraction-First" architecture. All framework-heavy code is tucked away in the `src/base` directory, allowing you to focus on your business logic.
+### Performance & Scaling
+- **Caching**: Choose between local In-memory or distributed Redis caching.
+- **Background Jobs**: Native Inngest support for event-driven background functions.
+
+### Observability & Tooling
+- **Logging**: Console-based or OpenTelemetry + PostHog for production tracking.
+- **Development**: Choice of **Biome** (Ultra-fast) or **ESLint + Prettier**.
+- **Email**: Integrated **Resend** or traditional **SMTP** (Nodemailer).
+
+---
+
+## The Aura Blueprint
+
+The generated project structure is designed to isolate framework code from your business logic:
 
 ```text
 my-new-project/
 ├── src/
-│   ├── app.ts              # Entry point
-│   ├── routes/             # Your API routes go here
-│   ├── base/               # Framework abstractions (Route Registry, etc.)
+│   ├── app.ts              # Clean main entry point
+│   ├── routes/             # YOUR LOGIC: API endpoints live here
+│   ├── base/               # THE CORE: Framework abstractions (Internal)
 │   ├── config/             # Environment & service configurations
-│   ├── middlewares/        # Custom middlewares (Auth, Logging)
-│   ├── utils/              # Shared utilities (Zod helpers, Errors)
-│   └── [models/db/inngest] # Feature-specific directories
-├── .env                    # Pre-configured environment variables
+│   ├── middlewares/        # Custom middlewares (Auth, Logger)
+│   ├── utils/              # Shared utilities (Zod, Errors, Email)
+│   └── ...                 # Feature directories (models, inngest, etc.)
+├── .env                    # Pre-configured environment boilerplate
 ├── package.json
 └── tsconfig.json
 ```
 
-## 🚀 Getting Started
-
-Once generated, your project is ready to go:
-
-1. **Install Dependencies**:
-   ```bash
-   cd my-new-project
-   bun install
-   ```
-
-2. **Database Setup** (if applicable):
-   ```bash
-   bun run db:generate  # For Prisma
-   ```
-
-3. **Start Development**:
-   ```bash
-   bun run dev
-   ```
+---
 
-## 🛠️ Defining Routes
+## Defining Routes
 
-Aura makes route definition simple and type-safe using `defineRoute`:
+Aura makes route definition declarative and type-safe using the `defineRoute` utility:
 
 ```typescript
 import { defineRoute } from "../base";
 import { z } from "zod";
 
 export default defineRoute({
-  method: "GET",
-  path: "/hello",
+  method: "POST",
+  path: "/users",
   schema: {
-    query: z.object({ name: z.string().optional() })
+    body: z.object({ name: z.string(), email: z.string().email() })
   },
-  handler: async ({ req, res, query }) => {
-    res.json({ message: `Hello, ${query.name || "World"}!` });
+  handler: async ({ req, res, body }) => {
+    // Body is fully typed!
+    const { name, email } = body;
+    res.status(201).json({ success: true, user: { name, email } });
   },
 });
 ```
 
 ---
 
-Built with ❤️ by [Ahmad Javaid](https://github.com/ahmadjavaiddev)
+Built by [Ahmad Javaid](https://github.com/ahmadjavaiddev)

package/dist/index.js

@@ -1101,7 +1101,7 @@ ${r.caching==="redis"?"      redis,":""}
     };
   },
 });
-`}var Io=St(wt);async function Rr(r,t,o){let i=Le();i.start("Scaffolding your project...");let n=[r,c.join(r,"src"),c.join(r,"src","routes"),c.join(r,"src","base"),c.join(r,"src","config"),c.join(r,"src","middlewares"),c.join(r,"src","utils")];if(o.orm==="prisma")n.push(c.join(r,"prisma"));else if(o.orm==="drizzle")n.push(c.join(r,"src","db"));else if(o.orm==="mongoose")n.push(c.join(r,"src","models"));if(o.inngest!=="none")n.push(c.join(r,"src","inngest")),n.push(c.join(r,"src","inngest","functions"));for(let u of n)await p.mkdir(u,{recursive:!0});if(await p.writeFile(c.join(r,"package.json"),br(t,o)),await p.writeFile(c.join(r,"tsconfig.json"),Ge),await p.writeFile(c.join(r,".gitignore"),ke),await p.writeFile(c.join(r,".env"),xr(o,t)),o.formatter==="biome")await p.writeFile(c.join(r,"biome.json"),ze);else if(o.formatter==="prettier")await p.writeFile(c.join(r,".prettierrc"),qe),await p.writeFile(c.join(r,"eslint.config.js"),Ue);if(o.orm==="prisma")await p.writeFile(c.join(r,"prisma.config.ts"),Xe),await p.writeFile(c.join(r,"prisma","schema.prisma"),Ye);else if(o.orm==="drizzle")await p.writeFile(c.join(r,"drizzle.config.ts"),Fe);await p.writeFile(c.join(r,"src","app.ts"),ur(o)),await p.writeFile(c.join(r,"src","routes","health-route.ts"),yr(o));let s=c.join(r,"src"),e=c.join(s,"base"),a=c.join(s,"config"),d=c.join(s,"middlewares"),l=c.join(s,"utils");if(await p.writeFile(c.join(e,"index.ts"),Sr(o)),await p.writeFile(c.join(e,"define-route.ts"),hr(o)),await p.writeFile(c.join(e,"route-loader.ts"),Be),await p.writeFile(c.join(e,"route-registry.ts"),wr(o)),await p.writeFile(c.join(a,"env.ts"),Er(o,t)),await p.writeFile(c.join(l,"app-error.ts"),fe),await p.writeFile(c.join(l,"error-handler.ts"),vr(o)),o.caching!=="none"){if(o.caching==="redis")await p.writeFile(c.join(a,"redis.ts"),He),await p.writeFile(c.join(l,"cache.ts"),$e);else await p.writeFile(c.join(l,"cache.ts"),We);await p.writeFile(c.join(l,"cache-keys.ts"),Je)}if(o.logger!=="none"){if(o.logger==="otel")await p.writeFile(c.join(l,"logger.ts"),Ze);else await p.writeFile(c.join(l,"logger.ts"),Ve);await p.writeFile(c.join(d,"request-logger.ts"),Ke)}if(o.orm==="prisma")await p.writeFile(c.join(a,"prisma.ts"),Qe);else if(o.orm==="drizzle")await p.writeFile(c.join(a,"drizzle.ts"),De),await p.writeFile(c.join(r,"src","db","schema.ts"),er);else if(o.orm==="mongoose")await p.writeFile(c.join(a,"mongoose.ts"),rr),await p.writeFile(c.join(r,"src","models","user.model.ts"),tr);if(o.auth==="custom")await p.writeFile(c.join(d,"auth.ts"),or);else if(o.auth==="clerk")await p.writeFile(c.join(d,"auth.ts"),nr);else if(o.auth==="betterauth")await p.writeFile(c.join(d,"auth.ts"),ir);if(o.pagination)await p.writeFile(c.join(l,"pagination.ts"),ar);if(o.email==="resend")await p.writeFile(c.join(l,"email.ts"),sr);else if(o.email==="nodemailer")await p.writeFile(c.join(l,"email.ts"),mr);if(o.inngest!=="none"){let u=c.join(r,"src","inngest");await p.writeFile(c.join(u,"client.ts"),cr),await p.writeFile(c.join(u,"index.ts"),lr),await p.writeFile(c.join(u,"functions","hello-world.ts"),pr),await p.writeFile(c.join(r,"src","routes","inngest-route.ts"),dr)}return i.stop("Project generated successfully."),r}import Rt from"path";var Ir={name:"@ahmadjavaiddev/aura",version:"1.0.1",type:"module",description:"Interactive CLI scaffolder to generate custom API structures",main:"./dist/index.js",bin:{aura:"dist/index.js"},files:["dist"],publishConfig:{access:"public"},scripts:{start:"bun run src/cli.ts",build:"bun build ./src/cli.ts --outfile ./dist/index.js --target node --bundle --minify",prepublishOnly:"bun run build"},dependencies:{"@clack/prompts":"^0.8.2"},devDependencies:{"@types/bun":"latest","@types/node":"^22.0.0",typescript:"^5.0.0"}};async function It(){let r=process.argv.slice(2);if(r.includes("--version")||r.includes("-v"))console.log(`v${Ir.version}`),process.exit(0);if(r.includes("--help")||r.includes("-h"))console.log(`
+`}var Io=St(wt);async function Rr(r,t,o){let i=Le();i.start("Scaffolding your project...");let n=[r,c.join(r,"src"),c.join(r,"src","routes"),c.join(r,"src","base"),c.join(r,"src","config"),c.join(r,"src","middlewares"),c.join(r,"src","utils")];if(o.orm==="prisma")n.push(c.join(r,"prisma"));else if(o.orm==="drizzle")n.push(c.join(r,"src","db"));else if(o.orm==="mongoose")n.push(c.join(r,"src","models"));if(o.inngest!=="none")n.push(c.join(r,"src","inngest")),n.push(c.join(r,"src","inngest","functions"));for(let u of n)await p.mkdir(u,{recursive:!0});if(await p.writeFile(c.join(r,"package.json"),br(t,o)),await p.writeFile(c.join(r,"tsconfig.json"),Ge),await p.writeFile(c.join(r,".gitignore"),ke),await p.writeFile(c.join(r,".env"),xr(o,t)),o.formatter==="biome")await p.writeFile(c.join(r,"biome.json"),ze);else if(o.formatter==="prettier")await p.writeFile(c.join(r,".prettierrc"),qe),await p.writeFile(c.join(r,"eslint.config.js"),Ue);if(o.orm==="prisma")await p.writeFile(c.join(r,"prisma.config.ts"),Xe),await p.writeFile(c.join(r,"prisma","schema.prisma"),Ye);else if(o.orm==="drizzle")await p.writeFile(c.join(r,"drizzle.config.ts"),Fe);await p.writeFile(c.join(r,"src","app.ts"),ur(o)),await p.writeFile(c.join(r,"src","routes","health-route.ts"),yr(o));let s=c.join(r,"src"),e=c.join(s,"base"),a=c.join(s,"config"),d=c.join(s,"middlewares"),l=c.join(s,"utils");if(await p.writeFile(c.join(e,"index.ts"),Sr(o)),await p.writeFile(c.join(e,"define-route.ts"),hr(o)),await p.writeFile(c.join(e,"route-loader.ts"),Be),await p.writeFile(c.join(e,"route-registry.ts"),wr(o)),await p.writeFile(c.join(a,"env.ts"),Er(o,t)),await p.writeFile(c.join(l,"app-error.ts"),fe),await p.writeFile(c.join(l,"error-handler.ts"),vr(o)),o.caching!=="none"){if(o.caching==="redis")await p.writeFile(c.join(a,"redis.ts"),He),await p.writeFile(c.join(l,"cache.ts"),$e);else await p.writeFile(c.join(l,"cache.ts"),We);await p.writeFile(c.join(l,"cache-keys.ts"),Je)}if(o.logger!=="none"){if(o.logger==="otel")await p.writeFile(c.join(l,"logger.ts"),Ze);else await p.writeFile(c.join(l,"logger.ts"),Ve);await p.writeFile(c.join(d,"request-logger.ts"),Ke)}if(o.orm==="prisma")await p.writeFile(c.join(a,"prisma.ts"),Qe);else if(o.orm==="drizzle")await p.writeFile(c.join(a,"drizzle.ts"),De),await p.writeFile(c.join(r,"src","db","schema.ts"),er);else if(o.orm==="mongoose")await p.writeFile(c.join(a,"mongoose.ts"),rr),await p.writeFile(c.join(r,"src","models","user.model.ts"),tr);if(o.auth==="custom")await p.writeFile(c.join(d,"auth.ts"),or);else if(o.auth==="clerk")await p.writeFile(c.join(d,"auth.ts"),nr);else if(o.auth==="betterauth")await p.writeFile(c.join(d,"auth.ts"),ir);if(o.pagination)await p.writeFile(c.join(l,"pagination.ts"),ar);if(o.email==="resend")await p.writeFile(c.join(l,"email.ts"),sr);else if(o.email==="nodemailer")await p.writeFile(c.join(l,"email.ts"),mr);if(o.inngest!=="none"){let u=c.join(r,"src","inngest");await p.writeFile(c.join(u,"client.ts"),cr),await p.writeFile(c.join(u,"index.ts"),lr),await p.writeFile(c.join(u,"functions","hello-world.ts"),pr),await p.writeFile(c.join(r,"src","routes","inngest-route.ts"),dr)}return i.stop("Project generated successfully."),r}import Rt from"path";var Ir={name:"@ahmadjavaiddev/aura",version:"1.0.2",type:"module",description:"Interactive CLI scaffolder to generate custom API structures",main:"./dist/index.js",bin:{aura:"dist/index.js"},files:["dist"],publishConfig:{access:"public"},scripts:{start:"bun run src/cli.ts",build:"bun build ./src/cli.ts --outfile ./dist/index.js --target node --bundle --minify",prepublishOnly:"bun run build"},dependencies:{"@clack/prompts":"^0.8.2"},devDependencies:{"@types/bun":"latest","@types/node":"^22.0.0",typescript:"^5.0.0"}};async function It(){let r=process.argv.slice(2);if(r.includes("--version")||r.includes("-v"))console.log(`v${Ir.version}`),process.exit(0);if(r.includes("--help")||r.includes("-h"))console.log(`
 Usage: aura [project-name]
 
 Options:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ahmadjavaiddev/aura",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "type": "module",
   "description": "Interactive CLI scaffolder to generate custom API structures",
   "main": "./dist/index.js",