@kanjijs/auth 0.2.0-beta.1

package/README.md

@@ -0,0 +1,73 @@
+# @kanjijs/auth
+
+Authentication module for the Kanjijs Framework, powered by [Auth.js](https://authjs.dev/).
+
+## 📦 Features
+
+- **Auth.js Integration**: Use any Auth.js provider (GitHub, Google, Credentials, etc.).
+- **Global Auth**: Initialize authentication once for the entire application.
+- **Decorators**: `@Use(requireAuth)` and factory `requireRole("admin")`.
+- **Hono Native**: Built on top of `@hono/auth-js` and native middlewares.
+
+## 🚀 Usage
+
+### 1. Global Setup (Recommended)
+
+Import `AuthModule.forRoot` in your root module. This sets up the session middleware globally.
+
+```typescript
+// app.module.ts
+import { Module } from "@kanjijs/core";
+import { AuthModule } from "@kanjijs/auth";
+import GitHub from "@auth/core/providers/github";
+
+@Module({
+  imports: [
+    AuthModule.forRoot({
+      secret: process.env.AUTH_SECRET,
+      providers: [
+        GitHub({ clientId: "...", clientSecret: "..." })
+      ]
+    })
+  ]
+})
+export class AppModule {}
+```
+
+### 2. Protecting Routes
+
+Use the `requireAuth` middleware to guard routes. The `user` object will be available in the context.
+
+```typescript
+import { Controller, Get, Use } from "@kanjijs/core";
+import { requireAuth } from "@kanjijs/auth";
+import type { Context } from "hono";
+
+@Controller("/profile")
+export class ProfileController {
+  
+  @Get("/")
+  @Use(requireAuth) // 401 if not logged in
+  getProfile(c: Context) {
+    const user = c.get("user");
+    return { id: user.id, name: user.name };
+  }
+}
+```
+
+### 3. Role-Based Access
+
+```typescript
+import { requireRole } from "@kanjijs/auth";
+
+@Get("/admin")
+@Use(requireRole("admin")) // Checks user.role === 'admin'
+adminPanel(c: Context) {
+  return { ok: true };
+}
+```
+
+## 🛠️ Configuration
+
+The `config` object passed to `AuthModule.forRoot(config)` is strict `AuthConfig` from `@auth/core`. 
+Refer to [Auth.js Documentation](https://authjs.dev/reference/core#authconfig) for all available options (callbacks, pages, session strategy, etc.).