@vinetechke/next-error-logger 0.1.0-beta.1

package/dist/types-C3x_Ry2e.d.cts

@@ -0,0 +1,195 @@
+/**
+ * Log severity levels
+ */
+type LogLevel = 'error' | 'warn' | 'info' | 'debug';
+/**
+ * Represents a single error log entry stored in the database
+ */
+interface ErrorLogEntry {
+    /** Unique identifier for the log entry */
+    id: string;
+    /** Severity level of the log */
+    level: LogLevel;
+    /** Human-readable error message */
+    message: string;
+    /** Full stack trace (for errors) */
+    stack?: string | null;
+    /** ID of the user who encountered the error */
+    userId?: string | null;
+    /** Email of the user who encountered the error */
+    userEmail?: string | null;
+    /** Display name of the user */
+    userName?: string | null;
+    /** URL path where the error occurred */
+    path?: string | null;
+    /** HTTP method (GET, POST, etc.) */
+    method?: string | null;
+    /** Browser/client user agent string */
+    userAgent?: string | null;
+    /** Client IP address */
+    ip?: string | null;
+    /** Additional custom metadata */
+    metadata?: Record<string, unknown> | null;
+    /** Timestamp when the error occurred */
+    createdAt: Date;
+}
+/**
+ * Configuration options for the error logger
+ */
+interface ErrorLoggerConfig {
+    /** Database adapter for storing logs */
+    adapter: DatabaseAdapter;
+    /** Auth adapter for automatically capturing user context (optional) */
+    authAdapter?: AuthAdapter;
+    /** Number of days to retain logs (default: 30) */
+    retentionDays?: number;
+    /** Log levels to capture (default: all levels) */
+    levels?: LogLevel[];
+    /** Enable console output in development (default: true) */
+    consoleInDev?: boolean;
+}
+/**
+ * Database adapter interface - implement this for custom database support
+ */
+interface DatabaseAdapter {
+    /**
+     * Create a new log entry
+     * @param entry - The log entry data (without id and createdAt)
+     * @returns The created log entry with id and createdAt
+     */
+    create(entry: Omit<ErrorLogEntry, 'id' | 'createdAt'>): Promise<ErrorLogEntry>;
+    /**
+     * Find multiple log entries with filtering and pagination
+     * @param options - Query options
+     * @returns Object containing logs array and total count
+     */
+    findMany(options: QueryOptions): Promise<{
+        logs: ErrorLogEntry[];
+        total: number;
+    }>;
+    /**
+     * Find a single log entry by ID
+     * @param id - The log entry ID
+     * @returns The log entry or null if not found
+     */
+    findById(id: string): Promise<ErrorLogEntry | null>;
+    /**
+     * Delete a single log entry
+     * @param id - The log entry ID
+     */
+    delete(id: string): Promise<void>;
+    /**
+     * Delete multiple log entries
+     * @param options - Filter options for deletion
+     * @returns Number of deleted entries
+     */
+    deleteMany(options: {
+        before?: Date;
+        level?: LogLevel;
+    }): Promise<number>;
+}
+/**
+ * Auth adapter interface - implement this for custom auth providers
+ */
+interface AuthAdapter {
+    /**
+     * Get the current authenticated user
+     * @returns User object or null if not authenticated
+     */
+    getUser(): Promise<{
+        id: string;
+        email?: string;
+        name?: string;
+    } | null>;
+}
+/**
+ * Query options for filtering and paginating log entries
+ */
+interface QueryOptions {
+    /** Page number (1-indexed, default: 1) */
+    page?: number;
+    /** Number of items per page (default: 50) */
+    limit?: number;
+    /** Filter by log level */
+    level?: LogLevel;
+    /** Filter by user ID */
+    userId?: string;
+    /** Search term for message, stack, or path */
+    search?: string;
+    /** Filter logs after this date */
+    startDate?: Date;
+    /** Filter logs before this date */
+    endDate?: Date;
+    /** Field to sort by (default: createdAt) */
+    orderBy?: 'createdAt' | 'level';
+    /** Sort direction (default: desc) */
+    order?: 'asc' | 'desc';
+}
+/**
+ * Context information extracted from a request
+ */
+interface RequestContext {
+    /** URL path */
+    path?: string;
+    /** HTTP method */
+    method?: string;
+    /** User agent string */
+    userAgent?: string;
+    /** Client IP address */
+    ip?: string;
+    /** Additional custom metadata */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Result of a logging operation
+ */
+interface LogResult {
+    /** Whether the log was successfully stored */
+    success: boolean;
+    /** The created log entry (if successful) */
+    entry?: ErrorLogEntry;
+    /** Error message (if failed) */
+    error?: string;
+}
+/**
+ * Props for the LogViewer component
+ */
+interface LogViewerProps {
+    /** Base path for the logs API (default: /api/logs) */
+    apiBasePath?: string;
+    /** Additional CSS classes */
+    className?: string;
+    /** Number of logs per page (default: 50) */
+    pageSize?: number;
+    /** Custom theme colors */
+    theme?: LogViewerTheme;
+    /** Callback when a log is selected */
+    onLogSelect?: (log: ErrorLogEntry) => void;
+    /** Whether to show the delete button */
+    showDelete?: boolean;
+    /** Whether to auto-refresh (in seconds, 0 to disable) */
+    autoRefresh?: number;
+}
+/**
+ * Theme configuration for the LogViewer component
+ */
+interface LogViewerTheme {
+    /** Background color for error level badge */
+    errorBg?: string;
+    /** Text color for error level badge */
+    errorText?: string;
+    /** Background color for warn level badge */
+    warnBg?: string;
+    /** Text color for warn level badge */
+    warnText?: string;
+    /** Background color for info level badge */
+    infoBg?: string;
+    /** Text color for info level badge */
+    infoText?: string;
+    /** Background color for debug level badge */
+    debugBg?: string;
+    /** Text color for debug level badge */
+    debugText?: string;
+}
+
+export type { AuthAdapter as A, DatabaseAdapter as D, ErrorLoggerConfig as E, LogResult as L, QueryOptions as Q, RequestContext as R, ErrorLogEntry as a, LogLevel as b, LogViewerProps as c, LogViewerTheme as d };

package/dist/types-C3x_Ry2e.d.ts

@@ -0,0 +1,195 @@
+/**
+ * Log severity levels
+ */
+type LogLevel = 'error' | 'warn' | 'info' | 'debug';
+/**
+ * Represents a single error log entry stored in the database
+ */
+interface ErrorLogEntry {
+    /** Unique identifier for the log entry */
+    id: string;
+    /** Severity level of the log */
+    level: LogLevel;
+    /** Human-readable error message */
+    message: string;
+    /** Full stack trace (for errors) */
+    stack?: string | null;
+    /** ID of the user who encountered the error */
+    userId?: string | null;
+    /** Email of the user who encountered the error */
+    userEmail?: string | null;
+    /** Display name of the user */
+    userName?: string | null;
+    /** URL path where the error occurred */
+    path?: string | null;
+    /** HTTP method (GET, POST, etc.) */
+    method?: string | null;
+    /** Browser/client user agent string */
+    userAgent?: string | null;
+    /** Client IP address */
+    ip?: string | null;
+    /** Additional custom metadata */
+    metadata?: Record<string, unknown> | null;
+    /** Timestamp when the error occurred */
+    createdAt: Date;
+}
+/**
+ * Configuration options for the error logger
+ */
+interface ErrorLoggerConfig {
+    /** Database adapter for storing logs */
+    adapter: DatabaseAdapter;
+    /** Auth adapter for automatically capturing user context (optional) */
+    authAdapter?: AuthAdapter;
+    /** Number of days to retain logs (default: 30) */
+    retentionDays?: number;
+    /** Log levels to capture (default: all levels) */
+    levels?: LogLevel[];
+    /** Enable console output in development (default: true) */
+    consoleInDev?: boolean;
+}
+/**
+ * Database adapter interface - implement this for custom database support
+ */
+interface DatabaseAdapter {
+    /**
+     * Create a new log entry
+     * @param entry - The log entry data (without id and createdAt)
+     * @returns The created log entry with id and createdAt
+     */
+    create(entry: Omit<ErrorLogEntry, 'id' | 'createdAt'>): Promise<ErrorLogEntry>;
+    /**
+     * Find multiple log entries with filtering and pagination
+     * @param options - Query options
+     * @returns Object containing logs array and total count
+     */
+    findMany(options: QueryOptions): Promise<{
+        logs: ErrorLogEntry[];
+        total: number;
+    }>;
+    /**
+     * Find a single log entry by ID
+     * @param id - The log entry ID
+     * @returns The log entry or null if not found
+     */
+    findById(id: string): Promise<ErrorLogEntry | null>;
+    /**
+     * Delete a single log entry
+     * @param id - The log entry ID
+     */
+    delete(id: string): Promise<void>;
+    /**
+     * Delete multiple log entries
+     * @param options - Filter options for deletion
+     * @returns Number of deleted entries
+     */
+    deleteMany(options: {
+        before?: Date;
+        level?: LogLevel;
+    }): Promise<number>;
+}
+/**
+ * Auth adapter interface - implement this for custom auth providers
+ */
+interface AuthAdapter {
+    /**
+     * Get the current authenticated user
+     * @returns User object or null if not authenticated
+     */
+    getUser(): Promise<{
+        id: string;
+        email?: string;
+        name?: string;
+    } | null>;
+}
+/**
+ * Query options for filtering and paginating log entries
+ */
+interface QueryOptions {
+    /** Page number (1-indexed, default: 1) */
+    page?: number;
+    /** Number of items per page (default: 50) */
+    limit?: number;
+    /** Filter by log level */
+    level?: LogLevel;
+    /** Filter by user ID */
+    userId?: string;
+    /** Search term for message, stack, or path */
+    search?: string;
+    /** Filter logs after this date */
+    startDate?: Date;
+    /** Filter logs before this date */
+    endDate?: Date;
+    /** Field to sort by (default: createdAt) */
+    orderBy?: 'createdAt' | 'level';
+    /** Sort direction (default: desc) */
+    order?: 'asc' | 'desc';
+}
+/**
+ * Context information extracted from a request
+ */
+interface RequestContext {
+    /** URL path */
+    path?: string;
+    /** HTTP method */
+    method?: string;
+    /** User agent string */
+    userAgent?: string;
+    /** Client IP address */
+    ip?: string;
+    /** Additional custom metadata */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Result of a logging operation
+ */
+interface LogResult {
+    /** Whether the log was successfully stored */
+    success: boolean;
+    /** The created log entry (if successful) */
+    entry?: ErrorLogEntry;
+    /** Error message (if failed) */
+    error?: string;
+}
+/**
+ * Props for the LogViewer component
+ */
+interface LogViewerProps {
+    /** Base path for the logs API (default: /api/logs) */
+    apiBasePath?: string;
+    /** Additional CSS classes */
+    className?: string;
+    /** Number of logs per page (default: 50) */
+    pageSize?: number;
+    /** Custom theme colors */
+    theme?: LogViewerTheme;
+    /** Callback when a log is selected */
+    onLogSelect?: (log: ErrorLogEntry) => void;
+    /** Whether to show the delete button */
+    showDelete?: boolean;
+    /** Whether to auto-refresh (in seconds, 0 to disable) */
+    autoRefresh?: number;
+}
+/**
+ * Theme configuration for the LogViewer component
+ */
+interface LogViewerTheme {
+    /** Background color for error level badge */
+    errorBg?: string;
+    /** Text color for error level badge */
+    errorText?: string;
+    /** Background color for warn level badge */
+    warnBg?: string;
+    /** Text color for warn level badge */
+    warnText?: string;
+    /** Background color for info level badge */
+    infoBg?: string;
+    /** Text color for info level badge */
+    infoText?: string;
+    /** Background color for debug level badge */
+    debugBg?: string;
+    /** Text color for debug level badge */
+    debugText?: string;
+}
+
+export type { AuthAdapter as A, DatabaseAdapter as D, ErrorLoggerConfig as E, LogResult as L, QueryOptions as Q, RequestContext as R, ErrorLogEntry as a, LogLevel as b, LogViewerProps as c, LogViewerTheme as d };

package/package.json

@@ -0,0 +1,128 @@
+{
+  "name": "@vinetechke/next-error-logger",
+  "version": "0.1.0-beta.1",
+  "description": "Simple error logging for Next.js apps with user context, multiple database adapters, and a built-in dashboard.",
+  "author": "VineTechKE",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/vinetechke/next-error-logger"
+  },
+  "keywords": [
+    "nextjs",
+    "error-logging",
+    "monitoring",
+    "dashboard",
+    "prisma",
+    "drizzle",
+    "typescript",
+    "react"
+  ],
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./components": {
+      "types": "./dist/components/index.d.ts",
+      "import": "./dist/components/index.js",
+      "require": "./dist/components/index.cjs"
+    },
+    "./adapters/prisma": {
+      "types": "./dist/adapters/prisma.d.ts",
+      "import": "./dist/adapters/prisma.js",
+      "require": "./dist/adapters/prisma.cjs"
+    },
+    "./adapters/drizzle": {
+      "types": "./dist/adapters/drizzle.d.ts",
+      "import": "./dist/adapters/drizzle.js",
+      "require": "./dist/adapters/drizzle.cjs"
+    },
+    "./adapters/sql": {
+      "types": "./dist/adapters/sql.d.ts",
+      "import": "./dist/adapters/sql.js",
+      "require": "./dist/adapters/sql.cjs"
+    },
+    "./auth/next-auth": {
+      "types": "./dist/auth/next-auth.d.ts",
+      "import": "./dist/auth/next-auth.js",
+      "require": "./dist/auth/next-auth.cjs"
+    },
+    "./auth/clerk": {
+      "types": "./dist/auth/clerk.d.ts",
+      "import": "./dist/auth/clerk.js",
+      "require": "./dist/auth/clerk.cjs"
+    },
+    "./api": {
+      "types": "./dist/api/index.d.ts",
+      "import": "./dist/api/index.js",
+      "require": "./dist/api/index.cjs"
+    },
+    "./schemas/prisma": "./schemas/prisma.prisma",
+    "./schemas/drizzle": {
+      "types": "./dist/schemas/drizzle.d.ts",
+      "import": "./dist/schemas/drizzle.js",
+      "require": "./dist/schemas/drizzle.cjs"
+    },
+    "./schemas/sql": "./schemas/schema.sql"
+  },
+  "files": [
+    "dist",
+    "schemas",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "lint": "eslint src/",
+    "lint:fix": "eslint src/ --fix",
+    "format": "prettier --write \"src/**/*.{ts,tsx}\"",
+    "format:check": "prettier --check \"src/**/*.{ts,tsx}\"",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "prepublishOnly": "pnpm build && pnpm test"
+  },
+  "peerDependencies": {
+    "next": ">=14.0.0",
+    "react": ">=18.0.0",
+    "react-dom": ">=18.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@prisma/client": {
+      "optional": true
+    },
+    "drizzle-orm": {
+      "optional": true
+    },
+    "next-auth": {
+      "optional": true
+    },
+    "@clerk/nextjs": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@faker-js/faker": "^10.3.0",
+    "@testing-library/react": "^14.0.0",
+    "@types/node": "^20.0.0",
+    "@types/react": "^18.0.0",
+    "@typescript-eslint/eslint-plugin": "^7.0.0",
+    "@typescript-eslint/parser": "^7.0.0",
+    "@vitest/coverage-v8": "^1.0.0",
+    "eslint": "^8.0.0",
+    "jsdom": "^24.0.0",
+    "prettier": "^3.0.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.0.0",
+    "vitest": "^1.0.0"
+  },
+  "packageManager": "pnpm@10.27.0+sha512.72d699da16b1179c14ba9e64dc71c9a40988cbdc65c264cb0e489db7de917f20dcf4d64d8723625f2969ba52d4b7e2a1170682d9ac2a5dcaeaab732b7e16f04a"
+}

package/schemas/prisma.prisma

@@ -0,0 +1,23 @@
+// @vinetechke/next-error-logger - Prisma Schema
+// Copy this model to your schema.prisma file
+
+model ErrorLog {
+  id        String   @id @default(cuid())
+  level     String   // error, warn, info, debug
+  message   String   @db.Text
+  stack     String?  @db.Text
+  userId    String?
+  userEmail String?
+  userName  String?
+  path      String?
+  method    String?
+  userAgent String?
+  ip        String?
+  metadata  Json?
+  createdAt DateTime @default(now())
+
+  @@index([level])
+  @@index([userId])
+  @@index([createdAt])
+  @@map("error_logs")
+}

package/schemas/schema.sql

@@ -0,0 +1,75 @@
+-- @vinetechke/next-error-logger - SQL Schema
+-- Choose the appropriate schema for your database
+
+-- ============================================
+-- PostgreSQL
+-- ============================================
+CREATE TABLE error_logs (
+  id TEXT PRIMARY KEY,
+  level TEXT NOT NULL,
+  message TEXT NOT NULL,
+  stack TEXT,
+  user_id TEXT,
+  user_email TEXT,
+  user_name TEXT,
+  path TEXT,
+  method TEXT,
+  user_agent TEXT,
+  ip TEXT,
+  metadata JSONB,
+  created_at TIMESTAMP WITH TIME ZONE DEFAULT NOW()
+);
+
+CREATE INDEX idx_error_logs_level ON error_logs(level);
+CREATE INDEX idx_error_logs_user_id ON error_logs(user_id);
+CREATE INDEX idx_error_logs_created_at ON error_logs(created_at);
+
+-- ============================================
+-- MySQL
+-- ============================================
+/*
+CREATE TABLE error_logs (
+  id VARCHAR(36) PRIMARY KEY,
+  level VARCHAR(10) NOT NULL,
+  message TEXT NOT NULL,
+  stack TEXT,
+  user_id VARCHAR(255),
+  user_email VARCHAR(255),
+  user_name VARCHAR(255),
+  path VARCHAR(500),
+  method VARCHAR(10),
+  user_agent TEXT,
+  ip VARCHAR(45),
+  metadata JSON,
+  created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
+);
+
+CREATE INDEX idx_error_logs_level ON error_logs(level);
+CREATE INDEX idx_error_logs_user_id ON error_logs(user_id);
+CREATE INDEX idx_error_logs_created_at ON error_logs(created_at);
+*/
+
+-- ============================================
+-- SQLite
+-- ============================================
+/*
+CREATE TABLE error_logs (
+  id TEXT PRIMARY KEY,
+  level TEXT NOT NULL,
+  message TEXT NOT NULL,
+  stack TEXT,
+  user_id TEXT,
+  user_email TEXT,
+  user_name TEXT,
+  path TEXT,
+  method TEXT,
+  user_agent TEXT,
+  ip TEXT,
+  metadata TEXT,
+  created_at TEXT DEFAULT (datetime('now'))
+);
+
+CREATE INDEX idx_error_logs_level ON error_logs(level);
+CREATE INDEX idx_error_logs_user_id ON error_logs(user_id);
+CREATE INDEX idx_error_logs_created_at ON error_logs(created_at);
+*/