@djangocfg/nextjs 2.1.6 → 2.1.8

package/dist/config/index.d.mts

@@ -0,0 +1,360 @@
+import { NextConfig } from 'next';
+import { Configuration, Compiler } from 'webpack';
+export { A as AI_DOCS_HINT, b as MCP_API_URL, M as MCP_BASE_URL, a as MCP_SERVER_URL } from '../constants-HezbftFb.mjs';
+
+/**
+ * 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'],
+ * }));
+ * ```
+ */
+
+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;
+    /** Check for @djangocfg/* package updates on startup (default: true) */
+    checkUpdates?: boolean;
+    /** Auto-update outdated packages without prompting (default: false) */
+    autoUpdate?: boolean;
+    /** Force check workspace:* packages for updates (for testing in monorepo) */
+    forceCheckWorkspace?: boolean;
+    /** Check for missing optional packages on startup (default: true) */
+    checkPackages?: boolean;
+    /** Auto-install missing packages without prompting (default: false) */
+    autoInstall?: boolean;
+    /**
+     * Allow embedding this app in iframe from specified origins
+     * Set to ['*'] to allow all origins, or specify domains like ['https://djangocfg.com']
+     */
+    allowIframeFrom?: string[];
+    /** Custom webpack configuration function (called after base webpack logic) */
+    webpack?: (config: Configuration, options: {
+        isServer: boolean;
+        dev: boolean;
+        [key: string]: any;
+    }) => Configuration | 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;
+}
+/**
+ * Create base Next.js configuration with standard DjangoCFG settings
+ *
+ * @param options - Custom configuration options to merge with base config
+ * @returns Next.js configuration function
+ */
+declare function createBaseNextConfig(options?: BaseNextConfigOptions): NextConfig;
+
+/**
+ * Shared Constants for DjangoCFG Next.js Configuration
+ */
+declare const PACKAGE_NAME = "@djangocfg/nextjs";
+declare const DJANGO_CFG_BANNER = "\n\u2588\u2588\u2588\u2588\u2588\u2588\u2557      \u2588\u2588\u2557 \u2588\u2588\u2588\u2588\u2588\u2557 \u2588\u2588\u2588\u2557   \u2588\u2588\u2557 \u2588\u2588\u2588\u2588\u2588\u2588\u2557  \u2588\u2588\u2588\u2588\u2588\u2588\u2557      \u2588\u2588\u2588\u2588\u2588\u2588\u2557\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2557 \u2588\u2588\u2588\u2588\u2588\u2588\u2557\n\u2588\u2588\u2554\u2550\u2550\u2588\u2588\u2557     \u2588\u2588\u2551\u2588\u2588\u2554\u2550\u2550\u2588\u2588\u2557\u2588\u2588\u2588\u2588\u2557  \u2588\u2588\u2551\u2588\u2588\u2554\u2550\u2550\u2550\u2550\u255D \u2588\u2588\u2554\u2550\u2550\u2550\u2588\u2588\u2557    \u2588\u2588\u2554\u2550\u2550\u2550\u2550\u255D\u2588\u2588\u2554\u2550\u2550\u2550\u2550\u255D\u2588\u2588\u2554\u2550\u2550\u2550\u2550\u255D\n\u2588\u2588\u2551  \u2588\u2588\u2551     \u2588\u2588\u2551\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2551\u2588\u2588\u2554\u2588\u2588\u2557 \u2588\u2588\u2551\u2588\u2588\u2551  \u2588\u2588\u2588\u2557\u2588\u2588\u2551   \u2588\u2588\u2551    \u2588\u2588\u2551     \u2588\u2588\u2588\u2588\u2588\u2557  \u2588\u2588\u2551  \u2588\u2588\u2588\u2557\n\u2588\u2588\u2551  \u2588\u2588\u2551\u2588\u2588   \u2588\u2588\u2551\u2588\u2588\u2554\u2550\u2550\u2588\u2588\u2551\u2588\u2588\u2551\u255A\u2588\u2588\u2557\u2588\u2588\u2551\u2588\u2588\u2551   \u2588\u2588\u2551\u2588\u2588\u2551   \u2588\u2588\u2551    \u2588\u2588\u2551     \u2588\u2588\u2554\u2550\u2550\u255D  \u2588\u2588\u2551   \u2588\u2588\u2551\n\u2588\u2588\u2588\u2588\u2588\u2588\u2554\u255D\u255A\u2588\u2588\u2588\u2588\u2588\u2554\u255D\u2588\u2588\u2551  \u2588\u2588\u2551\u2588\u2588\u2551 \u255A\u2588\u2588\u2588\u2588\u2551\u255A\u2588\u2588\u2588\u2588\u2588\u2588\u2554\u255D\u255A\u2588\u2588\u2588\u2588\u2588\u2588\u2554\u255D    \u255A\u2588\u2588\u2588\u2588\u2588\u2588\u2557\u2588\u2588\u2551     \u255A\u2588\u2588\u2588\u2588\u2588\u2588\u2554\u255D\n\u255A\u2550\u2550\u2550\u2550\u2550\u255D  \u255A\u2550\u2550\u2550\u2550\u255D \u255A\u2550\u255D  \u255A\u2550\u255D\u255A\u2550\u255D  \u255A\u2550\u2550\u2550\u255D \u255A\u2550\u2550\u2550\u2550\u2550\u255D  \u255A\u2550\u2550\u2550\u2550\u2550\u255D      \u255A\u2550\u2550\u2550\u2550\u2550\u255D\u255A\u2550\u255D      \u255A\u2550\u2550\u2550\u2550\u2550\u255D\n";
+declare const DJANGOCFG_PACKAGES: readonly ["@djangocfg/ui-core", "@djangocfg/ui-nextjs", "@djangocfg/layouts", "@djangocfg/nextjs", "@djangocfg/api", "@djangocfg/centrifugo", "@djangocfg/eslint-config", "@djangocfg/typescript-config"];
+declare const DEFAULT_TRANSPILE_PACKAGES: readonly ["@djangocfg/ui-core", "@djangocfg/ui-nextjs", "@djangocfg/layouts", "@djangocfg/nextjs", "@djangocfg/api", "@djangocfg/centrifugo"];
+declare const DEFAULT_OPTIMIZE_PACKAGES: readonly ["@djangocfg/ui-core", "@djangocfg/ui-nextjs", "@djangocfg/layouts", "lucide-react", "recharts"];
+
+/**
+ * Deep Merge Utility
+ *
+ * Recursively merges objects, replacing arrays instead of merging them.
+ */
+declare function deepMerge<T extends Record<string, any>>(target: T, source: Partial<T>): T;
+
+/**
+ * Environment Variable Utilities
+ */
+declare const isStaticBuild: boolean;
+declare const isDev: boolean;
+declare const isProduction: boolean;
+declare const isCI: boolean;
+/**
+ * Get base path for static builds
+ */
+declare function getBasePath(isDefaultCfgAdmin?: boolean): string;
+/**
+ * Get API URL (empty for static builds)
+ */
+declare function getApiUrl(): string;
+/**
+ * Get Site URL (empty for static builds)
+ */
+declare function getSiteUrl(): string;
+
+/**
+ * Version Checking Utilities
+ */
+/**
+ * Get current package version from package.json
+ */
+declare function getCurrentVersion(): string | null;
+/**
+ * Fetch latest version from npm registry (with 1 hour caching via conf)
+ */
+declare function fetchLatestVersion(): Promise<string | null>;
+/**
+ * Check if update is available
+ */
+declare function checkForUpdate(): Promise<{
+    hasUpdate: boolean;
+    currentVersion: string | null;
+    latestVersion: string | null;
+}>;
+/**
+ * Get update command for all djangocfg packages
+ */
+declare function getUpdateCommand(): string;
+/**
+ * Print version info and update notification
+ */
+declare function printVersionInfo(): Promise<void>;
+
+/**
+ * Package Definitions
+ *
+ * Defines optional packages that can be auto-installed when needed.
+ */
+interface PackageDefinition {
+    /** npm package name */
+    name: string;
+    /** Human-readable description */
+    description: string;
+    /** When is this package needed? */
+    condition: 'static-build' | 'dev' | 'always';
+    /** Is this a dev dependency? */
+    devDependency: boolean;
+    /** Feature flag that enables this package */
+    featureFlag?: string;
+}
+/**
+ * Optional packages that can be auto-installed
+ */
+declare const OPTIONAL_PACKAGES: PackageDefinition[];
+/**
+ * Required peer dependencies (should already be installed)
+ */
+declare const PEER_DEPENDENCIES: readonly ["next", "react", "react-dom"];
+/**
+ * Get packages needed for current build context
+ */
+declare function getPackagesForContext(options: {
+    isStaticBuild: boolean;
+    isDev: boolean;
+}): PackageDefinition[];
+
+/**
+ * Package Checker
+ *
+ * Checks which optional packages are missing and need to be installed.
+ */
+
+interface MissingPackage extends PackageDefinition {
+    /** Why is this package needed? */
+    reason: string;
+}
+/**
+ * Check if a package is installed in the consumer's project
+ * Uses process.cwd() to check from the consumer's context, not the library's
+ */
+declare function isPackageInstalled(packageName: string): boolean;
+/**
+ * Get all missing packages for current context
+ */
+declare function getMissingPackages(): MissingPackage[];
+/**
+ * Check specific packages
+ */
+declare function checkPackages(packageNames: string[]): MissingPackage[];
+
+/**
+ * Package Installer
+ *
+ * Provides auto-installation functionality with user confirmation and progress indication.
+ */
+
+interface InstallOptions {
+    /** Auto-install without prompting */
+    autoInstall?: boolean;
+    /** Skip specific packages */
+    skipPackages?: string[];
+    /** Force prompt even if recently prompted */
+    force?: boolean;
+}
+interface InstallProgress {
+    current: number;
+    total: number;
+    package: string;
+    status: 'pending' | 'installing' | 'done' | 'error';
+}
+/**
+ * Detect package manager
+ */
+declare function detectPackageManager(): 'pnpm' | 'yarn' | 'npm';
+/**
+ * Build install command for a single package
+ */
+declare function buildSingleInstallCommand(packageName: string, isDev: boolean, pm: 'pnpm' | 'yarn' | 'npm'): string;
+/**
+ * Build install command for multiple packages (for display)
+ */
+declare function buildInstallCommand(packages: MissingPackage[], pm: 'pnpm' | 'yarn' | 'npm'): string;
+/**
+ * Install packages with progress indication
+ */
+declare function installPackagesWithProgress(packages: MissingPackage[]): Promise<boolean>;
+/**
+ * Install packages (simple version without per-package progress)
+ */
+declare function installPackages(packages: MissingPackage[]): Promise<boolean>;
+/**
+ * Check and prompt for missing packages
+ *
+ * Returns true if all packages are available (either already installed or just installed)
+ */
+declare function checkAndInstallPackages(options?: InstallOptions): Promise<boolean>;
+/**
+ * Reset installer preferences
+ */
+declare function resetInstallerPreferences(): void;
+
+/**
+ * Package Updater
+ *
+ * Checks for outdated @djangocfg/* packages and offers to update them.
+ */
+interface PackageVersion {
+    name: string;
+    current: string | null;
+    latest: string | null;
+    hasUpdate: boolean;
+}
+interface UpdateOptions {
+    /** Auto-update without prompting */
+    autoUpdate?: boolean;
+    /** Force check even if recently checked (ignores cooldown) */
+    force?: boolean;
+    /** Force check even for workspace:* packages (for testing) */
+    forceCheckWorkspace?: boolean;
+}
+/**
+ * Get installed version of a package from consumer's project
+ * Uses multiple fallback strategies for monorepo compatibility
+ */
+declare function getInstalledVersion(packageName: string): string | null;
+/**
+ * Check all @djangocfg packages for updates
+ * All packages are aligned to the version of @djangocfg/nextjs (master package)
+ * Skips workspace:* packages unless forceCheckWorkspace is true
+ */
+declare function checkForUpdates(options?: {
+    forceCheckWorkspace?: boolean;
+}): Promise<PackageVersion[]>;
+/**
+ * Get packages that need updating
+ */
+declare function getOutdatedPackages(options?: {
+    forceCheckWorkspace?: boolean;
+}): Promise<PackageVersion[]>;
+/**
+ * Update packages with progress
+ */
+declare function updatePackagesWithProgress(packages: PackageVersion[]): Promise<boolean>;
+/**
+ * Check and prompt for package updates
+ */
+declare function checkAndUpdatePackages(options?: UpdateOptions): Promise<boolean>;
+/**
+ * Reset updater preferences
+ */
+declare function resetUpdaterPreferences(): void;
+
+/**
+ * Dev Startup Webpack Plugin
+ *
+ * Handles banner display, version checking, package updates, and browser auto-open.
+ */
+
+interface DevStartupPluginOptions {
+    /** Auto-open browser */
+    openBrowser?: boolean;
+    /** Check for missing optional packages (default: true) */
+    checkPackages?: boolean;
+    /** Auto-install missing packages without prompting */
+    autoInstall?: boolean;
+    /** Check for @djangocfg/* package updates (default: true) */
+    checkUpdates?: boolean;
+    /** Auto-update packages without prompting */
+    autoUpdate?: boolean;
+    /** Force check workspace:* packages (for testing in monorepo) */
+    forceCheckWorkspace?: boolean;
+}
+/**
+ * Webpack plugin for dev startup tasks
+ */
+declare class DevStartupPlugin {
+    private options;
+    constructor(options?: DevStartupPluginOptions);
+    apply(compiler: Compiler): void;
+    private runStartupTasks;
+    private openBrowser;
+}
+/**
+ * Reset plugin state (useful for tests)
+ */
+declare function resetDevStartupState(): void;
+
+/**
+ * Compression Plugin Setup
+ *
+ * Adds Gzip and Brotli compression for static builds.
+ */
+
+interface CompressionPluginOptions {
+    /** Enable gzip compression */
+    gzip?: boolean;
+    /** Enable brotli compression */
+    brotli?: boolean;
+    /** Minimum file size to compress (default: 8192) */
+    threshold?: number;
+    /** Minimum compression ratio (default: 0.8) */
+    minRatio?: number;
+    /** Brotli compression level (default: 8) */
+    brotliLevel?: number;
+}
+/**
+ * Add compression plugins to webpack config
+ *
+ * Returns true if plugins were added, false if compression-webpack-plugin is not installed
+ */
+declare function addCompressionPlugins(config: Configuration, options?: CompressionPluginOptions): boolean;
+/**
+ * Check if compression is available
+ */
+declare function isCompressionAvailable(): boolean;
+
+export { type BaseNextConfigOptions, type CompressionPluginOptions, DEFAULT_OPTIMIZE_PACKAGES, DEFAULT_TRANSPILE_PACKAGES, DJANGOCFG_PACKAGES, DJANGO_CFG_BANNER, DevStartupPlugin, type DevStartupPluginOptions, type InstallOptions, type InstallProgress, type MissingPackage, OPTIONAL_PACKAGES, PACKAGE_NAME, PEER_DEPENDENCIES, type PackageDefinition, type PackageVersion, type UpdateOptions, addCompressionPlugins, buildInstallCommand, buildSingleInstallCommand, checkAndInstallPackages, checkAndUpdatePackages, checkForUpdate, checkForUpdates, checkPackages, createBaseNextConfig, deepMerge, detectPackageManager, fetchLatestVersion, getApiUrl, getBasePath, getCurrentVersion, getInstalledVersion, getMissingPackages, getOutdatedPackages, getPackagesForContext, getSiteUrl, getUpdateCommand, installPackages, installPackagesWithProgress, isCI, isCompressionAvailable, isDev, isPackageInstalled, isProduction, isStaticBuild, printVersionInfo, resetDevStartupState, resetInstallerPreferences, resetUpdaterPreferences, updatePackagesWithProgress };