better-auth-module

Better Auth Module

A private, reusable authentication module with Better Auth integration and a robust fallback mechanism.

Features

• 🔒 Seamless Better Auth integration
• 🔄 Reliable fallback mechanism for offline development
• 🛡️ Comprehensive error handling and logging
• 💾 Memory-cached user data for improved reliability
• 🔧 Easy installation and configuration
• 📝 Detailed documentation and examples

Quick Start

# Install the module
npm install @heikodietze/better-auth-module

# Initialize in your project
npx better-auth-init

Integration

Express.js Application

const express = require('express');
const { setupAuth } = require('@heikodietze/better-auth-module');

const app = express();

// Initialize Better Auth with fallback
setupAuth(app, {
  betterAuthSecret: process.env.BETTER_AUTH_SECRET,
  betterAuthUrl: process.env.BETTER_AUTH_URL,
  dataPath: './data',
  cookieOptions: {
    secure: process.env.NODE_ENV === 'production',
    maxAge: 30 * 24 * 60 * 60 * 1000 // 30 days
  }
});

// Your routes here
app.get('/', (req, res) => {
  res.send('Hello World');
});

app.listen(3000, () => {
  console.log('Server running on port 3000');
});

Configuration Options

Option	Description	Default
betterAuthSecret	Better Auth secret key	Required
betterAuthUrl	Better Auth API URL	https://api.better-auth.com
dataPath	Path to store fallback user data	./data
cookieOptions	Options for session cookies	See documentation
enableFallback	Enable fallback mechanism	true
logLevel	Logging verbosity	info

Best Practices & Lessons Learned

• Memory Caching: The module uses in-memory caching alongside file storage to prevent data loss and improve reliability.
• Error Handling: Specific error messages for different operations (signup vs signin) to avoid user confusion.
• File Operations: Atomic file operations with verification steps ensure data integrity.
• Session Management: Secure cookie-based sessions with proper HTTP security flags.

Advanced Usage

See the documentation for advanced usage examples and customization options.

License

Private - All Rights Reserved