@brainfish-ai/devdoc 0.1.42 → 0.1.43

package/renderer/lib/cache.ts

@@ -1,193 +0,0 @@
-/**
- * Universal caching utility that works in both local and production environments
- *
- * - Local development: Uses node-cache (in-memory)
- * - Production (Vercel): Uses Vercel KV
- *
- * Environment-based cache selection:
- * 1. Explicit override: CACHE_TYPE=local or CACHE_TYPE=kv
- * 2. Auto-detect: KV_REST_API_URL or KV_URL present → Uses Vercel KV
- * 3. Fallback: Uses local node-cache
- *
- * Example usage:
- * ```typescript
- * import { CacheUtils } from '@/utils/cache';
- *
- * // Get from cache
- * const cached = await CacheUtils.get<MyType>('my-key', { logHit: true });
- *
- * // Set with TTL
- * await CacheUtils.set('my-key', data, 3600, { log: true }); // 1 hour TTL
- *
- * // Delete
- * await CacheUtils.del('my-key', { log: true });
- * ```
- */
-
-import NodeCache from 'node-cache';
-import { kv } from '@vercel/kv';
-
-/**
- * Cache environment configuration
- */
-const CACHE_CONFIG = {
-  // Environment variables that indicate KV should be used
-  KV_INDICATORS: ['KV_REST_API_URL', 'KV_URL'] as const,
-  
-  // Allow explicit override via CACHE_TYPE env var
-  CACHE_TYPE: process.env.CACHE_TYPE as 'local' | 'kv' | undefined,
-} as const;
-
-/**
- * Determine cache type based on environment variables
- */
-function getCacheType(): 'local' | 'kv' {
-  // Explicit override takes precedence
-  if (CACHE_CONFIG.CACHE_TYPE === 'local') {
-    return 'local';
-  }
-  
-  if (CACHE_CONFIG.CACHE_TYPE === 'kv') {
-    return 'kv';
-  }
-  
-  // Auto-detect based on KV environment variables
-  const hasKVConfig = CACHE_CONFIG.KV_INDICATORS.some(
-    (envVar) => !!process.env[envVar]
-  );
-  
-  return hasKVConfig ? 'kv' : 'local';
-}
-
-// Determine cache type at module load time
-const cacheType = getCacheType();
-
-// Initialize cache backends based on environment
-let localCache: NodeCache | null = null;
-
-if (cacheType === 'kv') {
-  console.log('[Cache] Using Vercel KV cache');
-} else {
-  console.log('[Cache] Using local node-cache');
-  localCache = new NodeCache({
-    stdTTL: 60 * 60 * 24, // Default 24 hours TTL
-    checkperiod: 60 * 10, // Check for expired keys every 10 minutes
-    useClones: false, // Better performance, but be careful with object mutations
-  });
-}
-
-/**
- * Universal cache utility functions
- */
-export class CacheUtils {
-  /**
-   * Get a value from cache with optional logging
-   */
-  static async get<T = unknown>(
-    key: string,
-    options?: { logHit?: boolean }
-  ): Promise<T | null> {
-    try {
-      let value: T | undefined;
-
-      if (cacheType === 'kv') {
-        value = await kv.get(key) as T | undefined;
-      } else {
-        value = localCache?.get<T>(key);
-      }
-
-      // Fix: Only return null for missing keys (undefined), not for falsy values
-      const result = value !== undefined ? value : null;
-
-      if (options?.logHit) {
-        if (result !== null) {
-          console.log(`[Cache] HIT: ${key}`);
-        } else {
-          console.log(`[Cache] MISS: ${key}`);
-        }
-      }
-
-      return result;
-    } catch (error) {
-      console.warn(`[Cache] Get error for key "${key}":`, error);
-      return null;
-    }
-  }
-
-  /**
-   * Set a value in cache with TTL and logging
-   */
-  static async set<T = unknown>(
-    key: string,
-    value: T,
-    ttlSeconds?: number,
-    options?: { log?: boolean }
-  ): Promise<void> {
-    try {
-      if (cacheType === 'kv') {
-        if (ttlSeconds) {
-          await kv.set(key, value, { ex: ttlSeconds });
-        } else {
-          await kv.set(key, value);
-        }
-      } else {
-        const ttl = ttlSeconds || 60 * 60 * 24; // Default to 24 hours
-        localCache?.set(key, value, ttl);
-      }
-
-      if (options?.log) {
-        const ttlInfo = ttlSeconds ? ` (TTL: ${ttlSeconds}s)` : '';
-        console.log(`[Cache] SET: ${key}${ttlInfo}`);
-      }
-    } catch (error) {
-      console.warn(`[Cache] Set error for key "${key}":`, error);
-    }
-  }
-
-  /**
-   * Delete a key from cache
-   */
-  static async del(key: string, options?: { log?: boolean }): Promise<void> {
-    try {
-      if (cacheType === 'kv') {
-        await kv.del(key);
-      } else {
-        localCache?.del(key);
-      }
-
-      if (options?.log) {
-        console.log(`[Cache] DEL: ${key}`);
-      }
-    } catch (error) {
-      console.warn(`[Cache] Delete error for key "${key}":`, error);
-    }
-  }
-
-  /**
-   * Clear all cache entries (use with caution!)
-   */
-  static async clear(): Promise<void> {
-    try {
-      if (cacheType === 'kv') {
-        await kv.flushdb();
-      } else {
-        localCache?.flushAll();
-      }
-      console.log('[Cache] Cleared all entries');
-    } catch (error) {
-      console.warn('[Cache] Clear error:', error);
-    }
-  }
-
-  /**
-   * Get current cache type for debugging/monitoring
-   */
-  static getCacheType(): 'local' | 'kv' {
-    return cacheType;
-  }
-}
-
-// Legacy exports for backward compatibility
-export const cache = CacheUtils;
-export { cacheType };
-export default CacheUtils;

package/renderer/lib/docs/config/domain-schema.ts

@@ -1,260 +0,0 @@
-import { z } from 'zod'
-
-/**
- * Domain Configuration Schema (domain.json)
- * 
- * Configuration for custom domains on DevDoc projects.
- * Each project can have ONE custom domain for free.
- */
-
-// ============================================================================
-// Domain Validation Helpers
-// ============================================================================
-
-/**
- * Valid domain pattern - allows subdomains like docs.example.com
- * Does NOT allow:
- * - IP addresses
- * - Ports
- * - Paths
- * - Protocol prefixes
- */
-const domainRegex = /^(?!-)[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*\.[a-zA-Z]{2,}$/
-
-/**
- * Reserved domains that cannot be used as custom domains
- */
-const RESERVED_DOMAINS = [
-  'devdoc.sh',
-  'devdoc.io',
-  'devdoc.com',
-  'localhost',
-]
-
-// ============================================================================
-// SEO Schema
-// ============================================================================
-
-const domainSeoSchema = z.object({
-  /**
-   * Canonical URL for SEO - tells search engines this is the primary URL
-   * Should match your custom domain with https://
-   */
-  canonical: z.string().url().optional(),
-})
-
-// ============================================================================
-// Settings Schema
-// ============================================================================
-
-const domainSettingsSchema = z.object({
-  /**
-   * Force HTTPS redirects (recommended, default: true)
-   */
-  forceHttps: z.boolean().default(true),
-  
-  /**
-   * WWW redirect preference
-   * - "www": Redirect non-www to www (example.com → www.example.com)
-   * - "non-www": Redirect www to non-www (www.example.com → example.com)
-   * - "none": No redirect, accept both
-   */
-  wwwRedirect: z.enum(['www', 'non-www', 'none']).default('none'),
-})
-
-// ============================================================================
-// Main Domain Configuration Schema
-// ============================================================================
-
-export const domainConfigSchema = z.object({
-  /**
-   * JSON Schema reference (optional)
-   */
-  $schema: z.string().optional(),
-  
-  /**
-   * The custom domain for this project
-   * Example: "docs.example.com" or "developer.mycompany.io"
-   * 
-   * Rules:
-   * - Must be a valid domain name
-   * - Cannot be a DevDoc domain (*.devdoc.sh)
-   * - One custom domain per project (free)
-   */
-  customDomain: z.string()
-    .min(4, 'Domain must be at least 4 characters')
-    .max(253, 'Domain must be 253 characters or less')
-    .regex(domainRegex, 'Invalid domain format. Example: docs.example.com')
-    .refine(
-      (domain) => !RESERVED_DOMAINS.some(reserved => 
-        domain === reserved || domain.endsWith(`.${reserved}`)
-      ),
-      'Cannot use a reserved DevDoc domain'
-    ),
-  
-  /**
-   * SEO configuration for the custom domain
-   */
-  seo: domainSeoSchema.optional(),
-  
-  /**
-   * Domain behavior settings
-   */
-  settings: domainSettingsSchema.optional(),
-})
-
-// ============================================================================
-// Types
-// ============================================================================
-
-export type DomainConfig = z.infer<typeof domainConfigSchema>
-export type DomainSeoConfig = z.infer<typeof domainSeoSchema>
-export type DomainSettings = z.infer<typeof domainSettingsSchema>
-
-// ============================================================================
-// Domain Status Types (for API/storage)
-// ============================================================================
-
-/**
- * Status of a custom domain in the system
- */
-export type DomainStatus = 
-  | 'pending'           // Domain added, awaiting DNS configuration
-  | 'dns_verified'      // DNS records verified, awaiting SSL
-  | 'ssl_provisioning'  // SSL certificate being provisioned
-  | 'active'            // Domain is live and working
-  | 'error'             // Configuration error
-
-/**
- * Custom domain entry stored in the registry
- */
-export interface CustomDomainEntry {
-  /** The custom domain (e.g., "docs.example.com") */
-  customDomain: string
-  
-  /** The project slug this domain points to */
-  projectSlug: string
-  
-  /** Current status of the domain */
-  status: DomainStatus
-  
-  /** Vercel domain ID (from Vercel API) */
-  vercelDomainId?: string
-  
-  /** TXT record value for domain ownership verification */
-  verificationToken?: string
-  
-  /** When the domain was added */
-  createdAt: string
-  
-  /** When DNS was verified */
-  verifiedAt?: string
-  
-  /** Last time status was checked */
-  lastCheckedAt?: string
-  
-  /** Error message if status is "error" */
-  errorMessage?: string
-  
-  /** Domain settings from domain.json */
-  settings?: DomainSettings
-}
-
-// ============================================================================
-// Validation Functions
-// ============================================================================
-
-/**
- * Parse and validate domain configuration
- */
-export function parseDomainConfig(data: unknown): DomainConfig {
-  const result = domainConfigSchema.safeParse(data)
-  
-  if (!result.success) {
-    const issues = result.error.issues || []
-    const errors = issues.map((e) => 
-      `${e.path.map(String).join('.')}: ${e.message}`
-    ).join('\n')
-    throw new Error(`Invalid domain.json configuration:\n${errors}`)
-  }
-  
-  return result.data
-}
-
-/**
- * Safe parse that returns null on failure
- */
-export function safeParseDomainConfig(data: unknown): DomainConfig | null {
-  const result = domainConfigSchema.safeParse(data)
-  return result.success ? result.data : null
-}
-
-/**
- * Validate a domain string format
- */
-export function isValidDomain(domain: string): { valid: boolean; error?: string } {
-  if (!domain) {
-    return { valid: false, error: 'Domain is required' }
-  }
-  
-  if (domain.length < 4) {
-    return { valid: false, error: 'Domain must be at least 4 characters' }
-  }
-  
-  if (domain.length > 253) {
-    return { valid: false, error: 'Domain must be 253 characters or less' }
-  }
-  
-  if (!domainRegex.test(domain)) {
-    return { valid: false, error: 'Invalid domain format. Example: docs.example.com' }
-  }
-  
-  // Check reserved domains
-  if (RESERVED_DOMAINS.some(reserved => 
-    domain === reserved || domain.endsWith(`.${reserved}`)
-  )) {
-    return { valid: false, error: 'Cannot use a reserved DevDoc domain' }
-  }
-  
-  return { valid: true }
-}
-
-/**
- * Normalize a domain (lowercase, trim, remove protocol/path)
- */
-export function normalizeDomain(domain: string): string {
-  let normalized = domain.toLowerCase().trim()
-  
-  // Remove protocol if present
-  normalized = normalized.replace(/^https?:\/\//, '')
-  
-  // Remove path if present
-  normalized = normalized.split('/')[0]
-  
-  // Remove port if present
-  normalized = normalized.split(':')[0]
-  
-  return normalized
-}
-
-/**
- * Get DNS instructions for a custom domain
- */
-export function getDnsInstructions(customDomain: string): {
-  cname: { name: string; value: string }
-  txt: { name: string; value: string }
-} {
-  const parts = customDomain.split('.')
-  const subdomain = parts.length > 2 ? parts[0] : '@'
-  
-  return {
-    cname: {
-      name: subdomain === '@' ? customDomain : subdomain,
-      value: 'cname.devdoc-dns.com',
-    },
-    txt: {
-      name: `_devdoc-verify.${customDomain}`,
-      value: '', // Will be filled with actual verification token
-    },
-  }
-}

package/renderer/lib/docs/config/index.ts

@@ -1,43 +0,0 @@
-/**
- * Configuration Module Exports
- */
-
-export {
-  docsConfigSchema,
-  parseDocsConfig,
-  safeParseDocsConfig,
-  getDefaultDocsConfig,
-  type DocsConfig,
-  type NavigationTab,
-  type NavigationGroup,
-  type NavLink,
-  type Anchor,
-  type ColorConfig,
-  type LogoConfig,
-  type ApiConfig,
-} from './schema'
-
-export {
-  domainConfigSchema,
-  parseDomainConfig,
-  safeParseDomainConfig,
-  isValidDomain,
-  normalizeDomain,
-  getDnsInstructions,
-  type DomainConfig,
-  type DomainSeoConfig,
-  type DomainSettings,
-  type DomainStatus,
-  type CustomDomainEntry,
-} from './domain-schema'
-
-export {
-  loadDocsConfig,
-  safeLoadDocsConfig,
-  clearConfigCache,
-  hasDocsConfig,
-  getContentDir,
-  resolvePagePath,
-  loadPageContent,
-  listMdxFiles,
-} from './loader'

package/renderer/lib/docs/config/loader.ts

@@ -1,142 +0,0 @@
-import { readFileSync, existsSync, readdirSync } from 'fs'
-import { join } from 'path'
-import { parseDocsConfig, type DocsConfig } from './schema'
-
-/**
- * Configuration Loader
- * 
- * Utilities for loading and caching docs.json configuration
- * Uses synchronous fs operations for compatibility with Next.js Turbopack
- */
-
-// Cache for loaded configuration
-let configCache: DocsConfig | null = null
-let configCachePath: string | null = null
-
-/**
- * Load docs.json configuration from a directory
- */
-export function loadDocsConfig(docsDir: string): DocsConfig {
-  const configFilePath = join(docsDir, 'docs.json')
-  
-  // Return cached config if path matches
-  if (configCache && configCachePath === configFilePath) {
-    return configCache
-  }
-  
-  try {
-    if (!existsSync(configFilePath)) {
-      throw new Error(`docs.json not found at ${configFilePath}`)
-    }
-    
-    const configContent = readFileSync(configFilePath, 'utf-8')
-    const rawConfig = JSON.parse(configContent)
-    const config = parseDocsConfig(rawConfig)
-    
-    // Cache the result
-    configCache = config
-    configCachePath = configFilePath
-    
-    return config
-  } catch (error) {
-    if (error instanceof Error) {
-      throw new Error(`Failed to load docs.json: ${error.message}`)
-    }
-    throw error
-  }
-}
-
-/**
- * Load configuration without throwing (returns null on failure)
- */
-export function safeLoadDocsConfig(docsDir: string): DocsConfig | null {
-  try {
-    return loadDocsConfig(docsDir)
-  } catch {
-    return null
-  }
-}
-
-/**
- * Clear the configuration cache
- */
-export function clearConfigCache(): void {
-  configCache = null
-  configCachePath = null
-}
-
-/**
- * Check if a docs.json file exists in a directory
- */
-export function hasDocsConfig(docsDir: string): boolean {
-  return existsSync(join(docsDir, 'docs.json'))
-}
-
-/**
- * Get the content directory path from configuration
- */
-export function getContentDir(docsDir: string): string {
-  return docsDir
-}
-
-/**
- * Resolve a page path to a file path
- */
-export function resolvePagePath(
-  docsDir: string, 
-  pagePath: string
-): string | null {
-  const contentDir = getContentDir(docsDir)
-  const extensions = ['.mdx', '.md']
-  
-  // Try different extensions
-  for (const ext of extensions) {
-    const filePath = join(contentDir, `${pagePath}${ext}`)
-    if (existsSync(filePath)) {
-      return filePath
-    }
-  }
-  
-  // Try as directory with index file
-  for (const ext of extensions) {
-    const indexPath = join(contentDir, pagePath, `index${ext}`)
-    if (existsSync(indexPath)) {
-      return indexPath
-    }
-  }
-  
-  return null
-}
-
-/**
- * Load page content from a resolved path
- */
-export function loadPageContent(filePath: string): string {
-  return readFileSync(filePath, 'utf-8')
-}
-
-/**
- * List all MDX files in a directory recursively
- */
-export function listMdxFiles(dir: string): string[] {
-  const files: string[] = []
-  
-  function walk(currentDir: string) {
-    const entries = readdirSync(currentDir, { withFileTypes: true })
-    
-    for (const entry of entries) {
-      const fullPath = join(currentDir, entry.name)
-      
-      if (entry.isDirectory()) {
-        if (!entry.name.startsWith('.') && entry.name !== 'node_modules') {
-          walk(fullPath)
-        }
-      } else if (entry.isFile() && (entry.name.endsWith('.mdx') || entry.name.endsWith('.md'))) {
-        files.push(fullPath)
-      }
-    }
-  }
-  
-  walk(dir)
-  return files
-}