@revealui/core 0.0.1-pre.4 → 0.2.0

package/dist/nextjs/withRevealUI.js

@@ -0,0 +1,181 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+// Get __dirname equivalent for ESM
+// Since package.json has "type": "module", we're in ESM context
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+/**
+ * Next.js configuration wrapper for RevealUI
+ * Provides webpack aliases, environment variables, and build configuration
+ *
+ * Sets up `@revealui/config` alias to import the RevealUI config file.
+ * The alias works with both Webpack (Next.js < 15) and Turbopack (Next.js 16+).
+ */
+export function withRevealUI(nextConfig = {}, options = {}) {
+    const { configPath = './revealui.config.ts', admin = true, adminRoute = '/admin', apiRoute = '/api', } = options;
+    /**
+     * Resolve config file path with validation
+     * Attempts multiple extensions (.ts, .js, .mjs) if base path doesn't exist
+     */
+    const resolveConfigPath = (baseDir) => {
+        const basePath = path.isAbsolute(configPath) ? configPath : path.resolve(baseDir, configPath);
+        // Try exact path first
+        if (fs.existsSync(basePath)) {
+            return basePath;
+        }
+        // Try with extensions if no extension provided
+        const extensions = ['.ts', '', '.mjs'];
+        const baseWithoutExt = path.parse(basePath);
+        for (const ext of extensions) {
+            const candidate = path.format({
+                ...baseWithoutExt,
+                base: undefined,
+                ext: ext,
+            });
+            if (fs.existsSync(candidate)) {
+                return candidate;
+            }
+        }
+        // If not found, throw helpful error
+        throw new Error(`RevealUI config file not found: ${basePath}\n` +
+            `Searched for: ${basePath}, ${extensions.map((ext) => path.format({ ...baseWithoutExt, base: undefined, ext })).join(', ')}\n` +
+            `Please ensure the config file exists or provide a valid configPath option.`);
+    };
+    return {
+        ...nextConfig,
+        // Environment variables for RevealUI
+        env: {
+            ...nextConfig.env,
+            REVEALUI_CONFIG_PATH: configPath,
+            REVEALUI_ADMIN_ENABLED: admin.toString(),
+            REVEALUI_ADMIN_ROUTE: adminRoute,
+            REVEALUI_API_ROUTE: apiRoute,
+        },
+        // Webpack configuration (for Next.js < 15 or when not using Turbopack)
+        webpack: (config, context) => {
+            const { isServer, dev } = context;
+            void isServer;
+            void dev;
+            // Apply any existing webpack config first
+            if (nextConfig.webpack) {
+                config = nextConfig.webpack(config, context);
+            }
+            // Resolve config path at execution time (when webpack runs)
+            // This ensures we're using the correct cwd for the Next.js project
+            const projectRoot = context.dir || process.cwd();
+            let resolvedConfigPath;
+            try {
+                resolvedConfigPath = resolveConfigPath(projectRoot);
+            }
+            catch (error) {
+                // In development, warn but don't fail - allow for dynamic config creation
+                if (dev) {
+                    // Lazy import logger to avoid ESM resolution issues at module load time
+                    import('../instance/logger.js')
+                        .then(({ defaultLogger }) => {
+                        defaultLogger.warn(error instanceof Error ? error.message : String(error));
+                    })
+                        .catch(() => {
+                        // Logger failed to load - silently continue (already falling back to default config path)
+                    });
+                    // Use fallback path
+                    resolvedConfigPath = path.isAbsolute(configPath)
+                        ? configPath
+                        : path.resolve(projectRoot, configPath);
+                }
+                else {
+                    // In production, fail fast
+                    throw error;
+                }
+            }
+            // Add RevealUI-specific webpack aliases
+            const resolve = (config.resolve || {});
+            config.resolve = resolve;
+            resolve.alias = {
+                ...resolve.alias,
+                // RevealUI core aliases - resolve to source index file
+                '@revealui/core': path.resolve(__dirname, '../index'),
+                // Config alias - resolves to the actual config file path in the Next.js project
+                // Use absolute path for reliable resolution
+                '@revealui/config': resolvedConfigPath,
+            };
+            // Also ensure it's in resolve.modules if needed (for some edge cases)
+            if (!resolve.modules) {
+                resolve.modules = ['node_modules'];
+            }
+            return config;
+        },
+        // Turbopack configuration (Next.js 16+)
+        // IMPORTANT: Turbopack's resolveAlias must be resolved at config evaluation time
+        // Turbopack should read tsconfig.json paths, but we also set it explicitly here for reliability
+        // If next.config.mjs already set @revealui/config, we respect it (it uses __dirname which is reliable).
+        turbopack: {
+            ...nextConfig.turbopack,
+            resolveAlias: {
+                // Start with existing aliases from next.config.mjs (which includes @revealui/config)
+                ...nextConfig.turbopack?.resolveAlias,
+                // RevealUI core aliases - use relative path for Turbopack compatibility
+                // Don't set @revealui/core here - let next.config.mjs handle it via the @revealui alias
+                // Ensure @revealui/config is set (next.config.mjs should have it, but ensure it's there)
+                // Use the existing one if present (prefer relative path for Turbopack)
+                // Otherwise resolve it to relative path from project root
+                '@revealui/config': nextConfig.turbopack?.resolveAlias?.['@revealui/config'] ||
+                    (() => {
+                        // Prefer relative path for Turbopack (matches tsconfig.json format)
+                        if (!path.isAbsolute(configPath)) {
+                            return configPath;
+                        }
+                        // If absolute, convert to relative from project root
+                        try {
+                            const projectRoot = process.cwd();
+                            const resolved = resolveConfigPath(projectRoot);
+                            if (fs.existsSync(resolved)) {
+                                // Return relative path from project root
+                                return path.relative(projectRoot, resolved);
+                            }
+                        }
+                        catch {
+                            // Fall through to fallback
+                        }
+                        // Fallback: use configPath as-is (should be relative)
+                        return configPath;
+                    })(),
+            },
+        },
+        // Headers for RevealUI
+        async headers() {
+            const existingHeaders = nextConfig.headers ? await nextConfig.headers() : [];
+            return [
+                ...existingHeaders,
+                // RevealUI admin headers
+                ...(admin
+                    ? [
+                        {
+                            source: `${adminRoute}/:path*`,
+                            headers: [
+                                {
+                                    key: 'X-Frame-Options',
+                                    value: 'SAMEORIGIN',
+                                },
+                                {
+                                    key: 'X-Content-Type-Options',
+                                    value: 'nosniff',
+                                },
+                            ],
+                        },
+                    ]
+                    : []),
+            ];
+        },
+        // Images configuration for RevealUI
+        images: {
+            ...nextConfig.images,
+            // Add RevealUI-specific image domains if needed
+            remotePatterns: [
+                ...(nextConfig.images?.remotePatterns || []),
+                // Add any RevealUI-specific image domains here
+            ],
+        },
+    };
+}

package/dist/observability/alerts.d.ts

@@ -0,0 +1,138 @@
+/**
+ * Alert System
+ *
+ * Configure and trigger alerts based on metrics and thresholds
+ */
+export type AlertSeverity = 'info' | 'warning' | 'error' | 'critical';
+export type AlertStatus = 'firing' | 'resolved';
+export interface Alert {
+    id: string;
+    name: string;
+    severity: AlertSeverity;
+    status: AlertStatus;
+    message: string;
+    details?: Record<string, unknown>;
+    timestamp: string;
+    resolvedAt?: string;
+    labels?: Record<string, string>;
+}
+export interface AlertRule {
+    name: string;
+    severity: AlertSeverity;
+    condition: () => boolean | Promise<boolean>;
+    message: string | ((context: Record<string, unknown>) => string);
+    labels?: Record<string, string>;
+    cooldown?: number;
+    enabled?: boolean;
+}
+export interface AlertChannel {
+    name: string;
+    send: (alert: Alert) => Promise<void>;
+    severities?: AlertSeverity[];
+}
+export declare class AlertingSystem {
+    private rules;
+    private channels;
+    private activeAlerts;
+    private lastFired;
+    /**
+     * Register alert rule
+     */
+    registerRule(rule: AlertRule): void;
+    /**
+     * Unregister alert rule
+     */
+    unregisterRule(name: string): void;
+    /**
+     * Add alert channel
+     */
+    addChannel(channel: AlertChannel): void;
+    /**
+     * Evaluate all rules
+     */
+    evaluateRules(): Promise<void>;
+    /**
+     * Fire an alert
+     */
+    private fireAlert;
+    /**
+     * Resolve an alert
+     */
+    private resolveAlert;
+    /**
+     * Send alert to channels
+     */
+    private sendAlert;
+    /**
+     * Get active alerts
+     */
+    getActiveAlerts(): Alert[];
+    /**
+     * Get alert by name
+     */
+    getAlert(name: string): Alert | undefined;
+    /**
+     * Start monitoring
+     */
+    startMonitoring(intervalMs?: number): NodeJS.Timeout;
+}
+/**
+ * Default alerting system
+ */
+export declare const alerting: AlertingSystem;
+/**
+ * Console alert channel
+ */
+export declare const consoleChannel: AlertChannel;
+/**
+ * Webhook alert channel
+ */
+export declare function createWebhookChannel(url: string, severities?: AlertSeverity[]): AlertChannel;
+/**
+ * Email alert channel
+ */
+export declare function createEmailChannel(sendEmailFn: (to: string, subject: string, body: string) => Promise<void>, recipients: string[], severities?: AlertSeverity[]): AlertChannel;
+/**
+ * Slack alert channel
+ */
+export declare function createSlackChannel(webhookUrl: string, severities?: AlertSeverity[]): AlertChannel;
+/**
+ * Common alert rules
+ */
+/**
+ * High error rate alert
+ */
+export declare function createErrorRateAlert(getErrorRate: () => number, threshold?: number): AlertRule;
+/**
+ * High response time alert
+ */
+export declare function createResponseTimeAlert(getP95: () => number, threshold?: number): AlertRule;
+/**
+ * Low cache hit rate alert
+ */
+export declare function createCacheHitRateAlert(getCacheHitRate: () => number, threshold?: number): AlertRule;
+/**
+ * High memory usage alert
+ */
+export declare function createMemoryUsageAlert(getMemoryUsage: () => number, threshold?: number): AlertRule;
+/**
+ * Database connection alert
+ */
+export declare function createDatabaseAlert(checkConnection: () => Promise<boolean>): AlertRule;
+/**
+ * Service health alert
+ */
+export declare function createServiceHealthAlert(serviceName: string, checkHealth: () => Promise<boolean>): AlertRule;
+/**
+ * Disk space alert
+ */
+export declare function createDiskSpaceAlert(getDiskUsage: () => number, threshold?: number): AlertRule;
+/**
+ * Queue size alert
+ */
+export declare function createQueueSizeAlert(queueName: string, getQueueSize: () => number, threshold?: number): AlertRule;
+/**
+ * Custom metric alert
+ */
+export declare function createMetricAlert(name: string, getMetric: () => number, threshold: number, operator?: '>' | '<' | '=', severity?: AlertSeverity): AlertRule;
+//# sourceMappingURL=alerts.d.ts.map

package/dist/observability/alerts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"alerts.d.ts","sourceRoot":"","sources":["../../src/observability/alerts.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,UAAU,CAAA;AACrE,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG,UAAU,CAAA;AAE/C,MAAM,WAAW,KAAK;IACpB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,aAAa,CAAA;IACvB,MAAM,EAAE,WAAW,CAAA;IACnB,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACjC,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAChC;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,aAAa,CAAA;IACvB,SAAS,EAAE,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAC3C,OAAO,EAAE,MAAM,GAAG,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,MAAM,CAAC,CAAA;IAChE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACrC,UAAU,CAAC,EAAE,aAAa,EAAE,CAAA;CAC7B;AAED,qBAAa,cAAc;IACzB,OAAO,CAAC,KAAK,CAAoC;IACjD,OAAO,CAAC,QAAQ,CAAqB;IACrC,OAAO,CAAC,YAAY,CAAgC;IACpD,OAAO,CAAC,SAAS,CAAiC;IAElD;;OAEG;IACH,YAAY,CAAC,IAAI,EAAE,SAAS,GAAG,IAAI;IAInC;;OAEG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAIlC;;OAEG;IACH,UAAU,CAAC,OAAO,EAAE,YAAY,GAAG,IAAI;IAIvC;;OAEG;IACG,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IAsBpC;;OAEG;YACW,SAAS;IAkCvB;;OAEG;YACW,YAAY;IAc1B;;OAEG;YACW,SAAS;IAmBvB;;OAEG;IACH,eAAe,IAAI,KAAK,EAAE;IAI1B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,GAAG,SAAS;IAIzC;;OAEG;IACH,eAAe,CAAC,UAAU,GAAE,MAAc,GAAG,MAAM,CAAC,OAAO;CAK5D;AAED;;GAEG;AACH,eAAO,MAAM,QAAQ,gBAAuB,CAAA;AAE5C;;GAEG;AACH,eAAO,MAAM,cAAc,EAAE,YA+B5B,CAAA;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,aAAa,EAAE,GAAG,YAAY,CAc5F;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,WAAW,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,EACzE,UAAU,EAAE,MAAM,EAAE,EACpB,UAAU,CAAC,EAAE,aAAa,EAAE,GAC3B,YAAY,CAsBd;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,aAAa,EAAE,GAAG,YAAY,CAoDjG;AAED;;GAEG;AAEH;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,YAAY,EAAE,MAAM,MAAM,EAAE,SAAS,GAAE,MAAU,GAAG,SAAS,CAQjG;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,MAAM,MAAM,EAAE,SAAS,GAAE,MAAa,GAAG,SAAS,CAQjG;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CACrC,eAAe,EAAE,MAAM,MAAM,EAC7B,SAAS,GAAE,MAAW,GACrB,SAAS,CAQX;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CACpC,cAAc,EAAE,MAAM,MAAM,EAC5B,SAAS,GAAE,MAAW,GACrB,SAAS,CAQX;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,eAAe,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,GAAG,SAAS,CAQtF;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CACtC,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,GAClC,SAAS,CAQX;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAClC,YAAY,EAAE,MAAM,MAAM,EAC1B,SAAS,GAAE,MAAW,GACrB,SAAS,CAQX;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAClC,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,MAAM,MAAM,EAC1B,SAAS,GAAE,MAAa,GACvB,SAAS,CAQX;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAC/B,IAAI,EAAE,MAAM,EACZ,SAAS,EAAE,MAAM,MAAM,EACvB,SAAS,EAAE,MAAM,EACjB,QAAQ,GAAE,GAAG,GAAG,GAAG,GAAG,GAAS,EAC/B,QAAQ,GAAE,aAAyB,GAClC,SAAS,CA0BX"}