@djangocfg/nextjs 1.0.6 → 2.1.1

package/src/config/base-next-config.ts

@@ -1,303 +0,0 @@
-/**
- * Base Next.js Configuration Factory
- *
- * Universal, reusable Next.js config for all DjangoCFG projects
- * Provides standard settings that can be extended per project
- *
- * @example
- * ```typescript
- * // In your project's next.config.ts
- * import { createBaseNextConfig } from '@djangocfg/nextjs/config';
- * import bundleAnalyzer from '@next/bundle-analyzer';
- *
- * const withBundleAnalyzer = bundleAnalyzer({
- *   enabled: process.env.ANALYZE === 'true',
- * });
- *
- * export default withBundleAnalyzer(createBaseNextConfig({
- *   // Your project-specific overrides
- *   transpilePackages: ['my-custom-package'],
- * }));
- * ```
- */
-
-import type { NextConfig } from 'next';
-import type { Configuration as WebpackConfig } from 'webpack';
-import chalk from 'chalk';
-import { deepMerge } from './deepMerge';
-
-// ─────────────────────────────────────────────────────────────────────────
-// Standard Environment Variables
-// ─────────────────────────────────────────────────────────────────────────
-
-const isStaticBuild = process.env.NEXT_PUBLIC_STATIC_BUILD === 'true';
-const isDev = process.env.NODE_ENV === 'development';
-
-// Global flag to track if browser was already opened (persists across hot reloads)
-let browserOpened = false;
-let bannerPrinted = false;
-
-// ASCII Art Banner for Django CFG
-const DJANGO_CFG_BANNER = `
-     888  d8b                                               .d888         
-     888  Y8P                                              d88P"          
-     888                                                   888            
- .d88888 8888  8888b.  88888b.   .d88b.   .d88b.   .d8888b 888888 .d88b.  
-d88" 888 "888     "88b 888 "88b d88P"88b d88""88b d88P"    888   d88P"88b 
-888  888  888 .d888888 888  888 888  888 888  888 888      888   888  888 
-Y88b 888  888 888  888 888  888 Y88b 888 Y88..88P Y88b.    888   Y88b 888 
- "Y88888  888 "Y888888 888  888  "Y88888  "Y88P"   "Y8888P 888    "Y88888 
-          888                        888                              888 
-         d88P                   Y8b d88P                         Y8b d88P 
-       888P"                     "Y88P"                           "Y88P"  
-`;
-
-// ─────────────────────────────────────────────────────────────────────────
-// Configuration Options
-// ─────────────────────────────────────────────────────────────────────────
-
-export interface BaseNextConfigOptions {
-  /** Static build path (used when NEXT_PUBLIC_STATIC_BUILD=true) */
-  isDefaultCfgAdmin?: boolean;
-  /** Additional transpile packages (merged with defaults) */
-  transpilePackages?: string[];
-  /** Additional optimize package imports (merged with defaults) */
-  optimizePackageImports?: string[];
-  /** Automatically open browser in dev mode (default: false) */
-  openBrowser?: boolean;
-  /** Custom webpack configuration function (called after base webpack logic) */
-  webpack?: (
-    config: WebpackConfig,
-    options: { isServer: boolean; dev: boolean;[key: string]: any }
-  ) => WebpackConfig | void;
-  /** Custom experimental options (merged with defaults) */
-  experimental?: NextConfig['experimental'];
-  /** Custom env variables (merged with defaults) */
-  env?: Record<string, string | undefined>;
-  /** Override any Next.js config option */
-  [key: string]: any;
-}
-
-// ─────────────────────────────────────────────────────────────────────────
-// Base Configuration Factory
-// ─────────────────────────────────────────────────────────────────────────
-
-/**
- * Create base Next.js configuration with standard DjangoCFG settings
- *
- * @param options - Custom configuration options to merge with base config
- * @returns Next.js configuration function
- */
-export function createBaseNextConfig(
-  options: BaseNextConfigOptions = {}
-): NextConfig {
-
-  // If static build not provided, use default for nextjs-admin development
-  const staticBuildPath = options.isDefaultCfgAdmin ? '/cfg/admin' : '/cfg/nextjs-admin';
-  const basePath = isStaticBuild ? staticBuildPath : '';
-  const apiUrl = isStaticBuild ? '' : process.env.NEXT_PUBLIC_API_URL || '';
-  const siteUrl = isStaticBuild ? '' : process.env.NEXT_PUBLIC_SITE_URL || '';
-
-  // Base configuration
-  const baseConfig: NextConfig = {
-    reactStrictMode: true,
-    trailingSlash: true,
-
-    // Static export configuration
-    ...(isStaticBuild && {
-      output: 'export' as const,
-      distDir: 'out',
-      basePath: basePath,
-      // assetPrefix: basePath,
-      // Fix for Next.js 15.5.4: prevent 500.html generation issue
-      // 
-      // PROBLEM: In App Router, error.tsx is a client component ('use client')
-      // and cannot be statically exported as 500.html. Next.js tries to create
-      // and move 500.html during static export, causing ENOENT error.
-      //
-      // SOLUTION: Use generateBuildId to work around the issue.
-      // The error.tsx component will still work in development/runtime mode.
-      generateBuildId: async () => {
-        return 'static-build';
-      },
-    }),
-
-    // Standalone output for Docker (only in production, not dev)
-    ...(!isStaticBuild && !isDev && {
-      output: 'standalone' as const,
-    }),
-
-    // Environment variables
-    env: {
-      NEXT_PUBLIC_BASE_PATH: basePath,
-      NEXT_PUBLIC_API_URL: apiUrl,
-      NEXT_PUBLIC_SITE_URL: siteUrl,
-      ...options.env,
-    },
-
-    // Images configuration
-    images: {
-      unoptimized: true,
-    },
-
-    // Transpile packages (merge with user-provided)
-    transpilePackages: [
-      '@djangocfg/ui',
-      '@djangocfg/layouts',
-      '@djangocfg/nextjs',
-      '@djangocfg/api',
-      '@djangocfg/centrifugo',
-      ...(options.transpilePackages || []),
-    ],
-
-    // Experimental features
-    // Base optimizations first, then user options (user can override base settings)
-    experimental: {
-      // Optimize package imports (only in production)
-      ...(!isDev && {
-        optimizePackageImports: [
-          '@djangocfg/ui',
-          '@djangocfg/layouts',
-          'lucide-react',
-          'recharts',
-          ...(options.optimizePackageImports || []),
-        ],
-      }),
-      // Dev mode optimizations
-      ...(isDev && {
-        optimizeCss: false,
-      }),
-      // User experimental options applied last (can override base settings)
-      ...options.experimental,
-    },
-
-    // Webpack configuration
-    webpack: (config: WebpackConfig, webpackOptions: { isServer: boolean; dev: boolean;[key: string]: any }) => {
-      const { isServer, dev } = webpackOptions;
-
-      // Print banner and auto-open browser in dev mode (client-side only)
-      if (dev && !isServer) {
-        // Create a simple plugin to print banner and open browser after first compilation
-        const DevStartupPlugin = class {
-          apply(compiler: any) {
-            compiler.hooks.done.tap('DevStartupPlugin', () => {
-              // Print banner only once
-              if (!bannerPrinted) {
-                bannerPrinted = true;
-                console.log('\n' + chalk.yellowBright.bold(DJANGO_CFG_BANNER) + '\n');
-              }
-
-              // Auto-open browser if enabled
-              if (options.openBrowser && !browserOpened) {
-                browserOpened = true;
-                // Delay to ensure server is ready
-                setTimeout(() => {
-                  const { exec } = require('child_process');
-                  const port = process.env.PORT || '3000';
-                  const url = `http://localhost:${port}`;
-                  
-                  const command = process.platform === 'darwin'
-                    ? 'open'
-                    : process.platform === 'win32'
-                    ? 'start'
-                    : 'xdg-open';
-                  
-                  exec(`${command} ${url}`, (error: Error | null) => {
-                    if (error) {
-                      console.warn(`Failed to open browser: ${error.message}`);
-                    }
-                  });
-                }, 2000); // Wait 2 seconds for server to be ready
-              }
-            });
-          }
-        };
-        
-        if (!config.plugins) {
-          config.plugins = [];
-        }
-        config.plugins.push(new DevStartupPlugin());
-      }
-
-      // Dev mode optimizations
-      if (dev) {
-        config.optimization = {
-          ...config.optimization,
-          removeAvailableModules: false,
-          removeEmptyChunks: false,
-          splitChunks: false, // Disable code splitting in dev for faster compilation
-        };
-      }
-
-      // Filesystem cache (dev and production)
-      config.cache = {
-        type: 'filesystem',
-        buildDependencies: {},
-      };
-
-      // Note: Dynamic API routes should use `export const dynamic = 'force-dynamic'`
-      // in the route file itself to exclude them from static export.
-      // This is simpler than using webpack plugins.
-
-      // Compression plugins (only for static build in production)
-      // Note: compression-webpack-plugin should be installed in the consuming project
-      if (!isServer && isStaticBuild && !dev) {
-        try {
-          // Dynamic import to avoid bundling compression-webpack-plugin
-          const CompressionPlugin = require('compression-webpack-plugin');
-
-          // Gzip compression
-          config.plugins.push(
-            new CompressionPlugin({
-              filename: '[path][base].gz',
-              algorithm: 'gzip',
-              test: /\.(js|css|html|svg|json)$/,
-              threshold: 8192,
-              minRatio: 0.8,
-            })
-          );
-
-          // Brotli compression (balanced level for speed/size)
-          config.plugins.push(
-            new CompressionPlugin({
-              filename: '[path][base].br',
-              algorithm: 'brotliCompress',
-              test: /\.(js|css|html|svg|json)$/,
-              threshold: 8192,
-              minRatio: 0.8,
-              compressionOptions: {
-                level: 8, // Balanced: good compression without excessive build time
-              },
-            })
-          );
-        } catch (error) {
-          // compression-webpack-plugin not installed, skip compression
-          console.warn('compression-webpack-plugin not found, skipping compression');
-        }
-      }
-
-      // Call user's webpack function if provided
-      if (options.webpack) {
-        return options.webpack(config, webpackOptions);
-      }
-
-      return config;
-    },
-
-  };
-
-  // Deep merge user options with base config
-  const finalConfig = deepMerge(baseConfig, options);
-
-  // Cleanup: Remove our custom options that are not part of NextConfig
-  // These are internal to BaseNextConfigOptions and should not be in the final config
-  delete (finalConfig as any).optimizePackageImports;
-  delete (finalConfig as any).isDefaultCfgAdmin;
-  delete (finalConfig as any).openBrowser;
-  // Note: We don't delete transpilePackages, experimental, env, webpack
-  // as they are valid NextConfig keys and may have been overridden by user
-
-  // Return clean NextConfig object (user should wrap with withBundleAnalyzer in their next.config.ts)
-  return finalConfig;
-}
-

package/src/config/deepMerge.ts

@@ -1,33 +0,0 @@
-
-// ─────────────────────────────────────────────────────────────────────────
-// Deep Merge Helper (simple implementation)
-// ─────────────────────────────────────────────────────────────────────────
-
-export function deepMerge<T extends Record<string, any>>(target: T, source: Partial<T>): T {
-    const output = { ...target };
-  
-    for (const key in source) {
-      if (source[key] === undefined) continue;
-  
-      // Arrays: replace (don't merge arrays)
-      if (Array.isArray(source[key])) {
-        output[key] = source[key] as any;
-      }
-      // Objects: deep merge
-      else if (source[key] && typeof source[key] === 'object' && !Array.isArray(source[key])) {
-        const targetValue = output[key];
-        if (targetValue && typeof targetValue === 'object' && !Array.isArray(targetValue)) {
-          output[key] = deepMerge(targetValue, source[key] as any);
-        } else {
-          output[key] = source[key] as any;
-        }
-      }
-      // Primitives: replace
-      else {
-        output[key] = source[key] as any;
-      }
-    }
-  
-    return output;
-  }
-