@buenojs/bueno 0.8.4 → 0.8.6

package/README.md

@@ -2,19 +2,20 @@
 
 A Bun-Native Full-Stack Framework
 
-[![Build Status](https://img.shields.io/github/actions/workflow/status/buenojs/bueno/ci.yml?branch=main)](https://github.com/buenojs/bueno/actions)
-[![Test Coverage](https://img.shields.io/codecov/c/gh/buenojs/bueno)](https://codecov.io/gh/buenojs/bueno)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/buenojs/bueno/ci.yml?branch=main&label=Tests)](https://github.com/buenojs/bueno/actions)
+[![Test Coverage](https://img.shields.io/codecov/c/gh/buenojs/bueno?label=Coverage)](https://codecov.io/gh/buenojs/bueno)
 [![npm version](https://img.shields.io/npm/v/@buenojs/bueno)](https://www.npmjs.com/package/@buenojs/bueno)
-[![License](https://img.shields.io/npm/l/@buenojs/bueno)](https://github.com/buenojs/bueno/blob/main/LICENSE)
+[![License](https://img.shields.io/badge/license-MIT-green)](https://github.com/buenojs/bueno/blob/main/LICENSE)
 [![Bun Version](https://img.shields.io/badge/bun-%3E%3D1.3.0-black)](https://bun.sh)
 [![Activity](https://img.shields.io/github/commit-activity/m/buenojs/bueno)](https://github.com/buenojs/bueno/graphs/commit-activity)
-[![Last Commit](https://img.shields.io/github/last-commit/buenojs/bueno)](https://github.com/buenojs/bueno/commits/main)
+[![Last Commit](https://img.shields.io/github/last-commit/buenojs/bueno/main)](https://github.com/buenojs/bueno/commits/main)
 
 ## Why Bueno?
 
 Bueno is a **Bun-native** full-stack framework designed from the ground up to leverage Bun's exceptional performance and modern JavaScript capabilities. Bueno embraces Bun's APIs, resulting in:
 
 - **Blazing Fast Performance**: Built on Bun's native HTTP server and optimized runtime
+- **Zero Dependencies**: True zero-dependency framework with built-in validation, ORM, caching, and jobs
 - **Zero Configuration**: Sensible defaults that work out of the box
 - **Full-Stack Integration**: Seamless frontend and backend development
 - **Type Safety**: End-to-end TypeScript with full type inference
@@ -224,6 +225,133 @@ bueno generate --help
 
 ## Core Features
 
+### Background Jobs
+Job queue system with Redis and memory drivers.
+
+```typescript
+import { JobQueue, createJobQueue, startWorker } from '@buenojs/bueno/jobs';
+
+// Create a job queue
+const queue = createJobQueue({
+  driver: 'redis',
+  redisUrl: 'redis://localhost:6379',
+});
+
+// Define a job handler
+queue.registerHandler('send-email', async (job) => {
+  const { to, subject, body } = job.data;
+  await emailService.send(to, subject, body);
+  return { success: true };
+});
+
+// Start a worker
+startWorker(queue, { concurrency: 5 });
+
+// Add a job to the queue
+await queue.add('send-email', {
+  to: 'user@example.com',
+  subject: 'Welcome!',
+  body: 'Thank you for joining our platform.',
+});
+```
+
+### Notifications
+Multi-channel notification system with support for email, SMS, WhatsApp, and push notifications.
+
+```typescript
+import { NotificationService, createNotificationService, EmailChannelService } from '@buenojs/bueno/notification';
+
+// Create notification service
+const notificationService = createNotificationService({
+  channels: [
+    new EmailChannelService({
+      smtp: {
+        host: 'smtp.gmail.com',
+        port: 587,
+        auth: {
+          user: 'your-email@gmail.com',
+          pass: 'your-password',
+        },
+      },
+    }),
+  ],
+});
+
+// Send a notification
+await notificationService.send({
+  to: 'user@example.com',
+  subject: 'Welcome!',
+  body: 'Thank you for joining our platform.',
+  channel: 'email',
+});
+```
+
+### Observability
+Structured error tracking and observability integration.
+
+```typescript
+import { createApp } from '@buenojs/bueno';
+import { ObservabilityModule } from '@buenojs/bueno/observability';
+
+const app = createApp(AppModule);
+
+// Wire observability with custom reporter (e.g., Sentry)
+const obs = ObservabilityModule.setup(app, {
+  reporter: new MyReporter(),
+  breadcrumbsSize: 20,
+  ignoreStatusCodes: [404, 401],
+  tags: { environment: 'production' },
+});
+
+await app.listen(3000);
+```
+
+### Metrics
+Runtime metrics collection for memory, CPU, and event loop lag.
+
+```typescript
+import { MetricsCollector, createMetricsCollector, toPrometheusFormat } from '@buenojs/bueno/metrics';
+
+// Create metrics collector
+const collector = createMetricsCollector({
+  maxHistorySize: 100,
+  measureEventLoopLag: true,
+});
+
+// Collect metrics periodically
+collector.startPeriodicCollection(5000);
+
+// Get metrics
+const metrics = collector.getLatest();
+console.log(toPrometheusFormat(metrics));
+```
+
+### i18n
+Internationalization support with translation loading and locale negotiation.
+
+```typescript
+import { I18n, createI18n, i18nMiddleware } from '@buenojs/bueno/i18n';
+
+// Create i18n instance
+const i18n = createI18n({
+  defaultLocale: 'en',
+  locales: ['en', 'fr', 'es'],
+  translations: {
+    en: {
+      welcome: 'Welcome!',
+      goodbye: 'Goodbye!',
+    },
+    fr: {
+      welcome: 'Bienvenue!',
+      goodbye: 'Au revoir!',
+    },
+  },
+});
+
+// Use middleware
+server.use(i18nMiddleware(i18n));
+```
+
 ### HTTP & Routing
 
 Bueno provides a powerful and intuitive routing system with full HTTP method support.
@@ -430,29 +558,145 @@ await schema.createTable('users', (table) => {
 
 ### Validation
 
-First-class support for popular validation libraries.
+Bueno includes a **zero-dependency** built-in validation system for common use cases, with optional support for external libraries like Zod, Valibot, and ArkType via the Standard Schema adapter.
+
+#### Built-in Validation (No Dependencies)
+
+```typescript
+import { Schema, Fields, validate, validateBody } from '@buenojs/bueno/validation';
+
+// Define schema with built-in validators
+const UserSchema = Schema.object({
+  name: Fields.string({ min: 1, max: 100 }),
+  email: Fields.string({ email: true }),
+  age: Fields.number({ positive: true, optional: true }),
+  role: Fields.enum(['admin', 'user', 'guest']),
+});
+
+// Validate in route
+router.post('/users', async (ctx) => {
+  const result = await validateBody(ctx, UserSchema);
+
+  if (!result.success) {
+    return ctx.status(400).json({
+      error: 'Validation failed',
+      issues: result.issues
+    });
+  }
+
+  const user = result.data; // Fully typed!
+});
+```
+
+#### Built-in Field Validators
+
+```typescript
+import { Fields } from '@buenojs/bueno/validation';
+
+Fields.string({
+  min: 1,           // Minimum length
+  max: 255,         // Maximum length
+  pattern: /regex/, // Regex validation
+  email: true,      // Email format
+  url: true,        // URL format
+  uuid: true,       // UUID format
+  optional: true,   // Allow undefined/null
+})
+
+Fields.number({
+  min: 0,           // Minimum value
+  max: 100,         // Maximum value
+  integer: true,    // Must be integer
+  positive: true,   // Must be > 0
+  optional: true,   // Allow undefined/null
+})
+
+Fields.boolean({ optional: true })
+
+Fields.array({
+  min: 1,           // Minimum items
+  max: 10,          // Maximum items
+  itemValidator: Fields.string(), // Validate each item
+  optional: true,
+})
+
+Fields.enum(['admin', 'user'], { optional: true })
+
+Fields.custom(
+  (value) => typeof value === 'string' && value.length > 0,
+  'Custom validation message'
+)
+```
+
+#### Middleware Validation
+
+```typescript
+import { createValidator } from '@buenojs/bueno/validation';
+
+const validateUserInput = createValidator({
+  body: UserSchema,
+  query: QuerySchema,
+  params: ParamsSchema,
+  headers: HeadersSchema,
+});
+
+router.post('/users/:id', validateUserInput, async (ctx) => {
+  const user = ctx.get('validatedBody');
+  const params = ctx.get('validatedParams');
+  // All validated and typed!
+});
+```
+
+#### Optional: Use External Validators (Zod, Valibot, ArkType)
+
+Bueno supports **any Standard Schema-compatible library**. Install your preferred validator and use it with Bueno's validation functions:
+
+```bash
+# Install your chosen validator (optional)
+bun add zod
+# or
+bun add valibot
+# or
+bun add arktype
+```
 
 ```typescript
-import { validate } from '@buenojs/bueno/validation';
-import { z } from 'zod';        // Zod
-import * as v from 'valibot';  // Valibot
-import { type } from 'arktype'; // ArkType
+import { validate, validateBody } from '@buenojs/bueno/validation';
+import { z } from 'zod'; // Optional, use any Standard Schema library
 
-// Zod schema
+// Use Zod schema (or Valibot, ArkType, Typia)
 const UserSchema = z.object({
   name: z.string().min(2),
   email: z.string().email(),
   age: z.number().int().positive().optional(),
 });
 
-// Validate in route
+// Works seamlessly with Bueno validators
 router.post('/users', async (ctx) => {
-  const body = await ctx.body();
-  const user = validate(body, UserSchema);
-  // user is fully typed!
+  const result = await validateBody(ctx, UserSchema);
+
+  if (!result.success) {
+    return ctx.status(400).json({
+      error: 'Validation failed',
+      issues: result.issues
+    });
+  }
+
+  const user = result.data;
 });
 ```
 
+#### Supported External Libraries
+
+| Library | Minimum Version | Status |
+|---------|-----------------|--------|
+| Zod | 4.0+ | ✅ Supported |
+| Valibot | 1.0+ | ✅ Supported |
+| ArkType | 2.0+ | ✅ Supported |
+| Typia | 7.0+ | ✅ Supported |
+
+All libraries using the **Standard Schema** interface are supported automatically.
+
 ### Security
 
 Comprehensive security features out of the box.
@@ -843,14 +1087,17 @@ Bueno combines the best ideas from popular frameworks while being optimized for
 | Feature | Bueno | Hono | Express | NestJS | Next.js |
 |---------|-------|------|---------|--------|---------|
 | **Runtime** | Bun | Multi | Node | Node | Node |
+| **Zero Dependencies** | ✅ | ✅ | ❌ | ❌ | ❌ |
 | **Router** | ✅ | ✅ | ✅ | ✅ | ✅ |
 | **DI Container** | ✅ | ❌ | ❌ | ✅ | ❌ |
 | **Decorators** | ✅ | ❌ | ❌ | ✅ | ❌ |
+| **Built-in Validation** | ✅ | ❌ | ❌ | ❌ | ❌ |
+| **Built-in ORM** | ✅ | ❌ | ❌ | ❌ | ❌ |
+| **Built-in Caching** | ✅ | ❌ | ❌ | ❌ | ❌ |
+| **Built-in Jobs** | ✅ | ❌ | ❌ | ❌ | ❌ |
 | **SSR** | ✅ | ❌ | ❌ | ❌ | ✅ |
 | **SSG** | ✅ | ❌ | ❌ | ❌ | ✅ |
-| **Database** | ✅ | ❌ | ❌ | ✅ | ❌ |
 | **WebSocket** | ✅ | ✅ | Plugin | ✅ | ❌ |
-| **Validation** | ✅ | ✅ | Plugin | ✅ | ❌ |
 | **CLI** | ✅ | ❌ | ❌ | ✅ | ✅ |
 
 **Migration Notes:**
@@ -882,7 +1129,7 @@ bun dev
 
 ## Links
 
-- **Documentation**: [https://buenojs.dev](https://buenojs.dev)
+- **Documentation**: [https://buenojs.dev](https://bueno.github.io)
 - **GitHub**: [https://github.com/buenojs/bueno](https://github.com/buenojs/bueno)
 - **Issues**: [https://github.com/buenojs/bueno/issues](https://github.com/buenojs/bueno/issues)
 - **npm**: [https://www.npmjs.com/package/@buenojs/bueno](https://www.npmjs.com/package/@buenojs/bueno)