@brainfish-ai/devdoc 0.1.42 → 0.1.44

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

@@ -1,308 +0,0 @@
-import { z } from 'zod'
-
-/**
- * Documentation Configuration Schema (docs.json)
- * 
- * Mintlify-compatible configuration schema for documentation sites.
- */
-
-// ============================================================================
-// Navigation Schemas
-// ============================================================================
-
-const anchorSchema = z.object({
-  anchor: z.string(),
-  href: z.string(),
-  icon: z.string().optional(),
-})
-
-const navLinkSchema = z.object({
-  label: z.string(),
-  href: z.string(),
-})
-
-// Page can be a string or a nested group
-const pageRefSchema: z.ZodType<string | { group: string; pages: (string | object)[] }> = z.lazy(() => 
-  z.union([
-    z.string(), // Page path like "quickstart" or "guides/intro"
-    z.object({  // Nested group
-      group: z.string(),
-      pages: z.array(z.union([z.string(), z.lazy(() => pageRefSchema)])),
-    }),
-  ])
-)
-
-const groupSchema = z.object({
-  group: z.string(),
-  pages: z.array(pageRefSchema),
-  icon: z.string().optional(),
-})
-
-// OpenAPI version schema
-const openapiVersionSchema = z.object({
-  version: z.string(),
-  spec: z.string(),
-  default: z.boolean().optional(),
-})
-
-// Different tab types
-const docsTabSchema = z.object({
-  tab: z.string(),
-  type: z.literal('docs').optional(),
-  groups: z.array(groupSchema),
-})
-
-const openapiTabSchema = z.object({
-  tab: z.string(),
-  type: z.literal('openapi'),
-  path: z.string().optional(),
-  versions: z.array(openapiVersionSchema).optional(),
-  spec: z.string().optional(),
-  groups: z.array(groupSchema).optional(), // Doc groups alongside API reference
-})
-
-const graphqlTabSchema = z.object({
-  tab: z.string(),
-  type: z.literal('graphql'),
-  path: z.string().optional(),
-  schema: z.string(), // GraphQL schema file path
-  endpoint: z.string().optional(), // GraphQL endpoint URL
-  groups: z.array(groupSchema).optional(), // Doc groups alongside API reference
-})
-
-const changelogTabSchema = z.object({
-  tab: z.string(),
-  type: z.literal('changelog'),
-  path: z.string().optional(),
-})
-
-const tabSchema = z.union([docsTabSchema, openapiTabSchema, graphqlTabSchema, changelogTabSchema])
-
-const navigationSchema = z.object({
-  tabs: z.array(tabSchema).optional(),
-  groups: z.array(groupSchema).optional(), // For single-tab sites
-  global: z.object({
-    anchors: z.array(anchorSchema).optional(),
-  }).optional(),
-})
-
-// ============================================================================
-// Theme & Branding Schemas
-// ============================================================================
-
-const colorSchema = z.object({
-  primary: z.string(),
-  light: z.string().optional(),
-  dark: z.string().optional(),
-  background: z.object({
-    light: z.string().optional(),
-    dark: z.string().optional(),
-  }).optional(),
-})
-
-const logoSchema = z.object({
-  light: z.string(),
-  dark: z.string(),
-  href: z.string().optional(),
-})
-
-const faviconSchema = z.string()
-
-// ============================================================================
-// Navbar Schema
-// ============================================================================
-
-const navbarPrimarySchema = z.object({
-  type: z.enum(['button', 'github', 'link']),
-  label: z.string().optional(),
-  href: z.string(),
-})
-
-const navbarSchema = z.object({
-  links: z.array(navLinkSchema).optional(),
-  primary: navbarPrimarySchema.optional(),
-})
-
-// ============================================================================
-// Footer Schema
-// ============================================================================
-
-const footerLinkSchema = z.object({
-  label: z.string(),
-  href: z.string(),
-})
-
-const footerGroupSchema = z.object({
-  title: z.string(),
-  links: z.array(footerLinkSchema),
-})
-
-const footerSchema = z.object({
-  socials: z.record(z.string(), z.string()).optional(),
-  links: z.array(footerGroupSchema).optional(),
-})
-
-// ============================================================================
-// API Configuration Schema
-// ============================================================================
-
-const apiAuthSchema = z.object({
-  method: z.enum(['bearer', 'basic', 'api-key', 'none']),
-  name: z.string().optional(),
-})
-
-const apiPlaygroundSchema = z.object({
-  mode: z.enum(['show', 'simple', 'hide']).optional(),
-})
-
-const apiConfigSchema = z.object({
-  baseUrl: z.string().optional(),
-  auth: apiAuthSchema.optional(),
-  playground: apiPlaygroundSchema.optional(),
-})
-
-// ============================================================================
-// SEO Schema
-// ============================================================================
-
-const seoSchema = z.object({
-  indexHiddenPages: z.boolean().optional(),
-  titleTemplate: z.string().optional(),
-})
-
-// ============================================================================
-// Integrations Schema
-// ============================================================================
-
-const analyticsSchema = z.object({
-  posthog: z.object({ apiKey: z.string() }).optional(),
-  googleAnalytics: z.object({ measurementId: z.string() }).optional(),
-  plausible: z.object({ domain: z.string() }).optional(),
-})
-
-const integrationsSchema = z.object({
-  analytics: analyticsSchema.optional(),
-})
-
-// ============================================================================
-// Contextual Menu Schema
-// ============================================================================
-
-const contextualOptionsEnum = z.enum([
-  'copy',
-  'view',
-  'chatgpt',
-  'claude',
-  'perplexity',
-  'mcp',
-  'cursor',
-  'vscode',
-])
-
-const contextualSchema = z.object({
-  options: z.array(contextualOptionsEnum).optional(),
-})
-
-// ============================================================================
-// Main Configuration Schema
-// ============================================================================
-
-export const docsConfigSchema = z.object({
-  // Schema reference (optional)
-  $schema: z.string().optional(),
-  
-  // Core identity
-  name: z.string(),
-  
-  // Theme
-  theme: z.enum(['default', 'mint', 'quill', 'venus']).optional(),
-  colors: colorSchema.optional(),
-  
-  // Branding
-  favicon: faviconSchema.optional(),
-  logo: logoSchema.optional(),
-  
-  // Navigation
-  navigation: navigationSchema,
-  
-  // Navbar
-  navbar: navbarSchema.optional(),
-  
-  // Footer
-  footer: footerSchema.optional(),
-  
-  // API Configuration
-  api: apiConfigSchema.optional(),
-  openapi: z.union([z.string(), z.array(z.string())]).optional(),
-  
-  // SEO
-  seo: seoSchema.optional(),
-  
-  // Integrations
-  integrations: integrationsSchema.optional(),
-  
-  // Contextual menu
-  contextual: contextualSchema.optional(),
-  
-  // Topbar style
-  topbar: z.object({
-    style: z.enum(['default', 'gradient']).optional(),
-  }).optional(),
-  
-  // Versioning
-  versions: z.array(z.string()).optional(),
-})
-
-// ============================================================================
-// Types
-// ============================================================================
-
-export type DocsConfig = z.infer<typeof docsConfigSchema>
-export type NavigationTab = z.infer<typeof tabSchema>
-export type NavigationGroup = z.infer<typeof groupSchema>
-export type NavLink = z.infer<typeof navLinkSchema>
-export type Anchor = z.infer<typeof anchorSchema>
-export type ColorConfig = z.infer<typeof colorSchema>
-export type LogoConfig = z.infer<typeof logoSchema>
-export type ApiConfig = z.infer<typeof apiConfigSchema>
-
-// ============================================================================
-// Validation Functions
-// ============================================================================
-
-/**
- * Parse and validate docs configuration
- */
-export function parseDocsConfig(data: unknown): DocsConfig {
-  const result = docsConfigSchema.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 docs.json configuration:\n${errors}`)
-  }
-  
-  return result.data
-}
-
-/**
- * Safe parse that returns null on failure
- */
-export function safeParseDocsConfig(data: unknown): DocsConfig | null {
-  const result = docsConfigSchema.safeParse(data)
-  return result.success ? result.data : null
-}
-
-/**
- * Get default configuration
- */
-export function getDefaultDocsConfig(): Partial<DocsConfig> {
-  return {
-    theme: 'default',
-    navigation: {
-      groups: [],
-    },
-  }
-}

package/renderer/lib/docs/index.ts

@@ -1,12 +0,0 @@
-/**
- * Documentation Library Exports
- */
-
-// MDX
-export * from './mdx'
-
-// Configuration
-export * from './config'
-
-// Navigation
-export * from './navigation'

package/renderer/lib/docs/mdx/compiler.ts

@@ -1,176 +0,0 @@
-import { compileMDX } from 'next-mdx-remote/rsc'
-import matter from 'gray-matter'
-import rehypeSlug from 'rehype-slug'
-import rehypeAutolinkHeadings from 'rehype-autolink-headings'
-import remarkGfm from 'remark-gfm'
-import { parseFrontmatter, safeParseFrontmatter, type Frontmatter } from './frontmatter'
-
-/**
- * MDX Compiler Utilities
- * 
- * Provides functions for compiling MDX content with custom components
- * and extracting frontmatter metadata
- */
-
-export interface MDXCompileResult<TFrontmatter = Frontmatter> {
-  content: React.ReactElement
-  frontmatter: TFrontmatter
-  headings: TableOfContentsItem[]
-}
-
-export interface TableOfContentsItem {
-  id: string
-  title: string
-  level: number
-}
-
-export interface CompileMDXOptions {
-  components?: Record<string, React.ComponentType<unknown>>
-  scope?: Record<string, unknown>
-  validateFrontmatter?: boolean
-}
-
-/**
- * Extract frontmatter from raw MDX content
- */
-export function extractFrontmatter(source: string): { 
-  content: string
-  data: Record<string, unknown>
-} {
-  const { content, data } = matter(source)
-  return { content, data }
-}
-
-/**
- * Extract headings from MDX content for table of contents
- */
-export function extractHeadings(content: string): TableOfContentsItem[] {
-  const headingRegex = /^(#{1,6})\s+(.+)$/gm
-  const headings: TableOfContentsItem[] = []
-  let match
-  
-  while ((match = headingRegex.exec(content)) !== null) {
-    const level = match[1].length
-    const title = match[2].trim()
-    // Generate slug from title (same logic as rehype-slug)
-    const id = title
-      .toLowerCase()
-      .replace(/[^a-z0-9]+/g, '-')
-      .replace(/^-+|-+$/g, '')
-    
-    headings.push({ id, title, level })
-  }
-  
-  return headings
-}
-
-/**
- * Compile MDX content with components and plugins
- */
-export async function compileMDXContent<TFrontmatter = Frontmatter>(
-  source: string,
-  options: CompileMDXOptions = {}
-): Promise<MDXCompileResult<TFrontmatter>> {
-  const { components = {}, scope = {}, validateFrontmatter = true } = options
-  
-  // Extract frontmatter first
-  const { content: mdxContent, data: rawFrontmatter } = extractFrontmatter(source)
-  
-  // Validate frontmatter if requested
-  const frontmatter = validateFrontmatter 
-    ? parseFrontmatter(rawFrontmatter) as TFrontmatter
-    : rawFrontmatter as TFrontmatter
-  
-  // Extract headings for ToC
-  const headings = extractHeadings(mdxContent)
-  
-  // Compile MDX
-  const { content } = await compileMDX({
-    source: mdxContent,
-    components,
-    options: {
-      parseFrontmatter: false, // Already extracted
-      mdxOptions: {
-        remarkPlugins: [remarkGfm],
-        rehypePlugins: [
-          rehypeSlug,
-          [rehypeAutolinkHeadings, { behavior: 'wrap' }],
-        ],
-      },
-      scope: {
-        ...scope,
-        frontmatter,
-      },
-    },
-  })
-  
-  return {
-    content,
-    frontmatter,
-    headings,
-  }
-}
-
-/**
- * Quick compile for previews (less validation)
- */
-export async function quickCompileMDX(
-  source: string,
-  components: Record<string, React.ComponentType<unknown>> = {}
-): Promise<{ content: React.ReactElement; frontmatter: Record<string, unknown> }> {
-  const { content: mdxContent, data: frontmatter } = extractFrontmatter(source)
-  
-  const { content } = await compileMDX({
-    source: mdxContent,
-    components,
-    options: {
-      parseFrontmatter: false,
-      mdxOptions: {
-        remarkPlugins: [remarkGfm],
-        rehypePlugins: [rehypeSlug],
-      },
-    },
-  })
-  
-  return { content, frontmatter }
-}
-
-/**
- * Validate MDX content without compiling (for linting)
- */
-export function validateMDXContent(source: string): {
-  valid: boolean
-  errors: string[]
-  warnings: string[]
-} {
-  const errors: string[] = []
-  const warnings: string[] = []
-  
-  try {
-    const { data } = extractFrontmatter(source)
-    
-    // Check frontmatter
-    const frontmatterResult = safeParseFrontmatter(data)
-    if (!frontmatterResult) {
-      errors.push('Invalid frontmatter format')
-    }
-    
-    // Check for common issues
-    if (!data.title) {
-      warnings.push('Missing title in frontmatter')
-    }
-    
-    if (!data.description) {
-      warnings.push('Missing description in frontmatter (recommended for SEO)')
-    }
-    
-  } catch (error) {
-    errors.push(`Parse error: ${error instanceof Error ? error.message : 'Unknown error'}`)
-  }
-  
-  return {
-    valid: errors.length === 0,
-    errors,
-    warnings,
-  }
-}

package/renderer/lib/docs/mdx/frontmatter.ts

@@ -1,91 +0,0 @@
-import { z } from 'zod'
-
-/**
- * Frontmatter Schema for MDX Documentation Pages
- * 
- * Defines the structure and validation for page metadata
- * Compatible with Mintlify-style frontmatter
- */
-
-export const frontmatterSchema = z.object({
-  // Core metadata
-  title: z.string(),
-  description: z.string().optional(),
-  
-  // Navigation
-  sidebarTitle: z.string().optional(),
-  icon: z.string().optional(),
-  
-  // Page behavior
-  // - 'default': Standard documentation page with max-width container
-  // - 'wide': Wide container for content that needs more space
-  // - 'custom': Full-width custom layout (no container, no header) - for landing pages
-  mode: z.enum(['default', 'wide', 'custom']).optional(),
-  
-  // Custom page options (only used when mode: 'custom')
-  // Hides the default page header (title & description)
-  hideHeader: z.boolean().optional(),
-  // Full-width layout without container constraints
-  fullWidth: z.boolean().optional(),
-  // Custom background color or gradient
-  background: z.string().optional(),
-  
-  // OpenAPI integration
-  openapi: z.string().optional(),
-  api: z.string().optional(),
-  
-  // SEO
-  'og:title': z.string().optional(),
-  'og:description': z.string().optional(),
-  'og:image': z.string().optional(),
-  'twitter:title': z.string().optional(),
-  'twitter:description': z.string().optional(),
-  
-  // Visibility
-  hidden: z.boolean().optional(),
-  noindex: z.boolean().optional(),
-  
-  // Version/Status
-  version: z.string().optional(),
-  deprecated: z.boolean().optional(),
-})
-
-export type Frontmatter = z.infer<typeof frontmatterSchema>
-
-/**
- * Parse and validate frontmatter data
- * Returns the validated data or throws an error with details
- */
-export function parseFrontmatter(data: unknown): Frontmatter {
-  const result = frontmatterSchema.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 frontmatter:\n${errors}`)
-  }
-  
-  return result.data
-}
-
-/**
- * Safe parse that returns null on failure instead of throwing
- */
-export function safeParseFrontmatter(data: unknown): Frontmatter | null {
-  const result = frontmatterSchema.safeParse(data)
-  return result.success ? result.data : null
-}
-
-/**
- * Get default frontmatter values
- */
-export function getDefaultFrontmatter(): Partial<Frontmatter> {
-  return {
-    mode: 'default',
-    hidden: false,
-    noindex: false,
-    deprecated: false,
-  }
-}

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

@@ -1,26 +0,0 @@
-/**
- * MDX Library Exports
- * 
- * Core utilities for MDX compilation and processing
- */
-
-// Compiler utilities
-export {
-  compileMDXContent,
-  quickCompileMDX,
-  validateMDXContent,
-  extractFrontmatter,
-  extractHeadings,
-  type MDXCompileResult,
-  type TableOfContentsItem,
-  type CompileMDXOptions,
-} from './compiler'
-
-// Frontmatter
-export {
-  frontmatterSchema,
-  parseFrontmatter,
-  safeParseFrontmatter,
-  getDefaultFrontmatter,
-  type Frontmatter,
-} from './frontmatter'