@aravindc26/velu 0.12.8 → 0.12.10

package/src/engine-core/types.ts

@@ -0,0 +1,49 @@
+export type VeluIconLibrary = 'fontawesome' | 'lucide' | 'tabler';
+
+export interface VeluDropdownOption {
+  dropdown: string;
+  slug: string;
+  description?: string;
+  icon?: string;
+  iconType?: string;
+  tabSlugs: string[];
+  defaultPath: string;
+}
+
+export interface VeluProductOption {
+  product: string;
+  slug: string;
+  description?: string;
+  icon?: string;
+  iconType?: string;
+  tabSlugs: string[];
+  defaultPath: string;
+}
+
+export interface VeluVersionOption {
+  version: string;
+  slug: string;
+  isDefault: boolean;
+  tabSlugs: string[];
+  defaultPath: string;
+}
+
+export interface VeluContextualOption {
+  id: string;
+  title: string;
+  description: string;
+  href?: string;
+  type: 'builtin' | 'custom';
+}
+
+export interface VeluAnchor {
+  anchor: string;
+  href?: string;
+  icon?: string;
+  iconType?: string;
+  color?: {
+    light: string;
+    dark: string;
+  };
+  hidden?: boolean;
+}

package/src/preview-engine/app/[sessionId]/[...slug]/page.tsx

@@ -1,41 +0,0 @@
-import { notFound } from 'next/navigation';
-import {
-  DocsBody,
-  DocsDescription,
-  DocsPage,
-  DocsTitle,
-} from 'fumadocs-ui/layouts/notebook/page';
-import { source } from '@/lib/source';
-
-interface PageProps {
-  params: Promise<{ sessionId: string; slug: string[] }>;
-}
-
-export default async function PreviewPage({ params }: PageProps) {
-  const { sessionId, slug } = await params;
-
-  // The full slug for fumadocs lookup includes the session ID prefix
-  const fullSlug = [sessionId, ...slug];
-  const page = source.getPage(fullSlug);
-
-  if (!page) notFound();
-
-  const pageDataRecord = page.data as unknown as Record<string, unknown>;
-  const MDX = pageDataRecord.body as any;
-  if (typeof MDX !== 'function') notFound();
-
-  return (
-    <DocsPage
-      toc={pageDataRecord.toc as any}
-      footer={{ enabled: false }}
-    >
-      <DocsTitle>{page.data.title}</DocsTitle>
-      {page.data.description ? (
-        <DocsDescription>{page.data.description}</DocsDescription>
-      ) : null}
-      <DocsBody>
-        <MDX />
-      </DocsBody>
-    </DocsPage>
-  );
-}

package/src/preview-engine/app/[sessionId]/layout.tsx

@@ -1,26 +0,0 @@
-import type { ReactNode } from 'react';
-import { DocsLayout } from 'fumadocs-ui/layouts/notebook';
-import { getSessionPageTree } from '@/lib/source';
-import { getSessionLayoutOptions } from '@/lib/session-layout';
-
-interface LayoutProps {
-  children: ReactNode;
-  params: Promise<{ sessionId: string }>;
-}
-
-export default async function SessionLayout({ children, params }: LayoutProps) {
-  const { sessionId } = await params;
-  const tree = getSessionPageTree(sessionId);
-  const base = getSessionLayoutOptions(sessionId);
-
-  return (
-    <DocsLayout
-      tree={tree}
-      {...base}
-      sidebar={{ collapsible: true }}
-      themeSwitch={{ enabled: false }}
-    >
-      {children}
-    </DocsLayout>
-  );
-}

package/src/preview-engine/app/global.css

@@ -1,29 +0,0 @@
-@import 'tailwindcss';
-@import 'fumadocs-ui/css/neutral.css';
-@import 'fumadocs-ui/css/preset.css';
-
-.velu-nav-brand {
-  display: inline-flex;
-  align-items: center;
-  gap: 0.25rem;
-  max-width: 100%;
-}
-
-.velu-nav-logo {
-  display: block;
-  height: 1.95rem;
-  width: auto;
-  max-width: 190px;
-}
-
-.velu-nav-logo-dark {
-  display: none;
-}
-
-.dark .velu-nav-logo-light {
-  display: none;
-}
-
-.dark .velu-nav-logo-dark {
-  display: block;
-}

package/src/preview-engine/lib/session-config.ts

@@ -1,86 +0,0 @@
-/**
- * Per-session configuration cache.
- * Reads docs.json from workspace directories and caches the parsed config.
- */
-import { existsSync, readFileSync } from 'node:fs';
-import { join } from 'node:path';
-
-const WORKSPACE_DIR = process.env.WORKSPACE_DIR || '/mnt/nfs_share/editor_sessions';
-const PRIMARY_CONFIG_NAME = 'docs.json';
-const LEGACY_CONFIG_NAME = 'velu.json';
-
-interface SessionConfig {
-  name?: string;
-  description?: string;
-  title?: string;
-  theme?: string;
-  colors?: { primary?: string; light?: string; dark?: string };
-  navigation: {
-    tabs?: any[];
-    languages?: any[];
-    anchors?: any[];
-    [key: string]: unknown;
-  };
-  languages?: string[];
-  openapi?: unknown;
-  [key: string]: unknown;
-}
-
-interface CachedSession {
-  config: SessionConfig;
-  rawConfig: Record<string, unknown>;
-  loadedAt: number;
-}
-
-const sessionCache = new Map<string, CachedSession>();
-const CACHE_TTL_MS = 60_000; // 1 minute
-
-function resolveWorkspaceConfigPath(sessionId: string): string | null {
-  const wsDir = join(WORKSPACE_DIR, sessionId);
-  const primary = join(wsDir, PRIMARY_CONFIG_NAME);
-  if (existsSync(primary)) return primary;
-  const legacy = join(wsDir, LEGACY_CONFIG_NAME);
-  if (existsSync(legacy)) return legacy;
-  return null;
-}
-
-export function getSessionConfig(sessionId: string): SessionConfig | null {
-  const cached = sessionCache.get(sessionId);
-  if (cached && Date.now() - cached.loadedAt < CACHE_TTL_MS) {
-    return cached.config;
-  }
-
-  const configPath = resolveWorkspaceConfigPath(sessionId);
-  if (!configPath) return null;
-
-  try {
-    const raw = JSON.parse(readFileSync(configPath, 'utf-8'));
-    const config = raw as SessionConfig;
-    sessionCache.set(sessionId, {
-      config,
-      rawConfig: raw,
-      loadedAt: Date.now(),
-    });
-    return config;
-  } catch {
-    return null;
-  }
-}
-
-export function getSessionRawConfig(sessionId: string): Record<string, unknown> | null {
-  getSessionConfig(sessionId); // ensure loaded
-  return sessionCache.get(sessionId)?.rawConfig ?? null;
-}
-
-export function clearSessionCache(sessionId: string): void {
-  sessionCache.delete(sessionId);
-}
-
-export function getWorkspaceDir(sessionId: string): string {
-  return join(WORKSPACE_DIR, sessionId);
-}
-
-export function getSiteName(sessionId: string): string {
-  const config = getSessionConfig(sessionId);
-  return config?.name || config?.title || 'Docs Preview';
-}

package/src/preview-engine/lib/session-layout.ts

@@ -1,190 +0,0 @@
-/**
- * Extracts DocsLayout options from a session's docs.json config.
- * Mirrors the main engine's layout.shared.ts + velu.ts config extraction
- * but reads from the per-session workspace config.
- */
-import { createElement, type ReactNode } from 'react';
-import type { BaseLayoutProps } from 'fumadocs-ui/layouts/shared';
-import { getSessionConfig, getSessionRawConfig } from './session-config';
-
-// ── Theme asset helpers ────────────────────────────────────────────────────
-
-interface ThemeAsset {
-  light?: string;
-  dark?: string;
-  href?: string;
-}
-
-function trimStr(value: unknown): string | undefined {
-  if (typeof value !== 'string') return undefined;
-  const trimmed = value.trim();
-  return trimmed.length > 0 ? trimmed : undefined;
-}
-
-function normalizeThemeAsset(value: unknown): ThemeAsset {
-  if (typeof value === 'string') {
-    const asset = trimStr(value);
-    return asset ? { light: asset, dark: asset } : {};
-  }
-  if (!value || typeof value !== 'object' || Array.isArray(value)) return {};
-  const record = value as Record<string, unknown>;
-  const light = trimStr(record.light);
-  const dark = trimStr(record.dark);
-  const fallback = trimStr(record.default);
-  const href = trimStr(record.href);
-  return {
-    light: light || fallback || undefined,
-    dark: dark || fallback || undefined,
-    href: href || undefined,
-  };
-}
-
-function resolveAssetUrl(sessionId: string, path: string | undefined): string | undefined {
-  if (!path) return undefined;
-  if (path.startsWith('http://') || path.startsWith('https://')) return path;
-  const clean = path.startsWith('/') ? path.slice(1) : path;
-  return `/api/sessions/${sessionId}/assets/${clean}`;
-}
-
-// ── Config extraction ──────────────────────────────────────────────────────
-
-function isRecord(value: unknown): value is Record<string, unknown> {
-  return typeof value === 'object' && value !== null && !Array.isArray(value);
-}
-
-interface AnchorEntry {
-  anchor: string;
-  href: string;
-  icon?: string;
-  hidden?: boolean;
-}
-
-function extractAnchors(list: unknown): AnchorEntry[] {
-  if (!Array.isArray(list)) return [];
-  return list.filter(
-    (a): a is AnchorEntry =>
-      isRecord(a) &&
-      typeof a.anchor === 'string' &&
-      typeof a.href === 'string' &&
-      a.href.length > 0 &&
-      !a.hidden,
-  );
-}
-
-function extractExternalTabs(config: Record<string, unknown>): Array<{ label: string; href: string }> {
-  const navigation = isRecord(config.navigation) ? config.navigation : {};
-  const tabs = Array.isArray(navigation.tabs) ? navigation.tabs : [];
-  const globalTabs = isRecord(navigation.global) && Array.isArray(navigation.global.tabs)
-    ? navigation.global.tabs
-    : [];
-
-  const tabLinks = tabs
-    .filter((tab): tab is Record<string, unknown> => isRecord(tab) && typeof tab.href === 'string' && tab.href.length > 0)
-    .map((tab) => ({ label: String(tab.tab ?? ''), href: String(tab.href) }));
-
-  const globalLinks = globalTabs
-    .filter((tab): tab is Record<string, unknown> => isRecord(tab) && typeof tab.href === 'string' && tab.href.length > 0)
-    .map((tab) => ({ label: String(tab.tab ?? ''), href: String(tab.href) }));
-
-  return [...tabLinks, ...globalLinks];
-}
-
-function extractNavbarAnchors(config: Record<string, unknown>): AnchorEntry[] {
-  const navigation = isRecord(config.navigation) ? config.navigation : {};
-  return extractAnchors(navigation.anchors);
-}
-
-function extractGlobalAnchors(config: Record<string, unknown>): AnchorEntry[] {
-  const navigation = isRecord(config.navigation) ? config.navigation : {};
-  const global = isRecord(navigation.global) ? navigation.global : {};
-  return extractAnchors(global.anchors);
-}
-
-function extractNavbarLinks(config: Record<string, unknown>): Array<{ label: string; href: string }> {
-  const navbar = isRecord(config.navbar) ? config.navbar : {};
-  const links = Array.isArray(navbar.links) ? navbar.links : [];
-  return links
-    .filter((link): link is Record<string, unknown> =>
-      isRecord(link) && typeof link.label === 'string' && typeof link.href === 'string',
-    )
-    .map((link) => ({ label: String(link.label), href: String(link.href) }));
-}
-
-// ── Public API ─────────────────────────────────────────────────────────────
-
-export function getSessionLayoutOptions(sessionId: string): BaseLayoutProps {
-  const config = getSessionConfig(sessionId);
-  const rawConfig = getSessionRawConfig(sessionId) ?? {};
-
-  const siteName = config?.name || config?.title || 'Docs Preview';
-  const logo = normalizeThemeAsset(config?.logo);
-  const lightLogo = resolveAssetUrl(sessionId, logo.light ?? logo.dark);
-  const darkLogo = resolveAssetUrl(sessionId, logo.dark ?? logo.light);
-  const logoHref = logo.href?.trim() || `/${sessionId}`;
-
-  const navTitle: ReactNode =
-    lightLogo || darkLogo
-      ? createElement(
-          'span',
-          { className: 'velu-nav-brand' },
-          lightLogo
-            ? createElement('img', {
-                src: lightLogo,
-                alt: siteName,
-                className: 'velu-nav-logo velu-nav-logo-light',
-              })
-            : null,
-          darkLogo
-            ? createElement('img', {
-                src: darkLogo,
-                alt: siteName,
-                className: 'velu-nav-logo velu-nav-logo-dark',
-              })
-            : null,
-        )
-      : siteName;
-
-  // Collect links: external tabs + navbar anchors + global anchors + navbar links
-  const externalTabs = extractExternalTabs(rawConfig);
-  const navbarAnchors = extractNavbarAnchors(rawConfig);
-  const globalAnchors = extractGlobalAnchors(rawConfig);
-  const navbarLinks = extractNavbarLinks(rawConfig);
-
-  const links = [
-    ...externalTabs.map((tab) => ({
-      text: tab.label,
-      url: tab.href,
-      secondary: false,
-    })),
-    ...navbarAnchors.map((a) => ({
-      text: a.anchor,
-      url: a.href,
-      secondary: true,
-    })),
-    ...globalAnchors.map((a) => ({
-      text: a.anchor,
-      url: a.href,
-      secondary: true,
-    })),
-    ...navbarLinks.map((link) => ({
-      text: link.label,
-      url: link.href,
-      secondary: true,
-    })),
-  ];
-
-  return {
-    nav: {
-      title: navTitle,
-      url: logoHref,
-    },
-    links,
-  };
-}
-
-export function getSessionFavicon(sessionId: string): string | undefined {
-  const config = getSessionConfig(sessionId);
-  const favicon = normalizeThemeAsset(config?.favicon);
-  const path = favicon.light ?? favicon.dark;
-  return resolveAssetUrl(sessionId, path);
-}

package/src/preview-engine/lib/source.ts

@@ -1,60 +0,0 @@
-import { loader } from 'fumadocs-core/source';
-import * as mdxCollections from 'fumadocs-mdx:collections/server';
-
-const docsCollection = (mdxCollections as { docs?: { toFumadocsSource?: () => unknown } }).docs;
-
-if (!docsCollection?.toFumadocsSource) {
-  throw new Error('MDX collections are not ready yet. Please retry in a moment.');
-}
-
-export const source = loader({
-  baseUrl: '/',
-  source: docsCollection.toFumadocsSource() as any,
-});
-
-/**
- * Get the page tree filtered to a specific session's content.
- * The content directory has files at {sessionId}/{slug}.mdx,
- * so the page tree has top-level folders per session.
- */
-export function getSessionPageTree(sessionId: string) {
-  const fullTree = source.getPageTree();
-  const children = Array.isArray(fullTree.children) ? fullTree.children : [];
-
-  // Find the root folder matching this session ID
-  const sessionFolder = children.find((child: any) => {
-    if (child?.type !== 'folder') return false;
-    // The folder's URL or name should match the session ID
-    const urls = collectUrls(child);
-    for (const url of urls) {
-      const firstSegment = url.replace(/^\/+/, '').split('/')[0];
-      if (firstSegment === sessionId) return true;
-    }
-    return false;
-  }) as any;
-
-  if (sessionFolder && Array.isArray(sessionFolder.children)) {
-    return { ...fullTree, children: sessionFolder.children };
-  }
-
-  // Fallback: filter children by URL prefix
-  const filtered = children.filter((child: any) => {
-    const urls = collectUrls(child);
-    return urls.some((url: string) => {
-      const segments = url.replace(/^\/+/, '').split('/');
-      return segments[0] === sessionId;
-    });
-  });
-
-  return { ...fullTree, children: filtered };
-}
-
-function collectUrls(node: any, out: string[] = []): string[] {
-  if (!node || typeof node !== 'object') return out;
-  if (typeof node.url === 'string') out.push(node.url);
-  if (node.index && typeof node.index.url === 'string') out.push(node.index.url);
-  if (Array.isArray(node.children)) {
-    for (const child of node.children) collectUrls(child, out);
-  }
-  return out;
-}

package/src/preview-engine/next.config.mjs

@@ -1,20 +0,0 @@
-import { resolve } from 'node:path';
-import { createMDX } from 'fumadocs-mdx/next';
-
-const withMDX = createMDX({
-  configPath: './source.config.ts',
-});
-
-/** @type {import('next').NextConfig} */
-const config = {
-  reactStrictMode: false,
-  devIndicators: false,
-  turbopack: {
-    root: '/',
-  },
-  images: {
-    unoptimized: true,
-  },
-};
-
-export default withMDX(config);

package/src/preview-engine/postcss.config.mjs

@@ -1,8 +0,0 @@
-import { createRequire } from 'node:module';
-const require = createRequire(import.meta.url);
-
-export default {
-  plugins: {
-    '@tailwindcss/postcss': {},
-  },
-};

package/src/preview-engine/source.config.ts

@@ -1,26 +0,0 @@
-import { defineConfig, defineDocs } from 'fumadocs-mdx/config';
-import { metaSchema, pageSchema } from 'fumadocs-core/source/schema';
-
-// Content directory: NFS-backed preview_content root.
-// Each session writes to {PREVIEW_CONTENT_DIR}/{sessionId}/.
-// fumadocs scans the entire directory; routes filter by session.
-const contentDir = process.env.PREVIEW_CONTENT_DIR || './content';
-
-export const docs = defineDocs({
-  dir: contentDir,
-  docs: {
-    schema: pageSchema,
-  },
-  meta: {
-    schema: metaSchema,
-  },
-});
-
-export default defineConfig({
-  mdxOptions: {
-    rehypeCodeOptions: ({
-      lazy: false,
-      fallbackLanguage: 'bash',
-    } as any),
-  },
-});

package/src/preview-engine/tsconfig.json

@@ -1,32 +0,0 @@
-{
-  "compilerOptions": {
-    "baseUrl": ".",
-    "target": "ESNext",
-    "lib": ["dom", "dom.iterable", "esnext"],
-    "allowJs": true,
-    "skipLibCheck": true,
-    "strict": true,
-    "forceConsistentCasingInFileNames": true,
-    "noEmit": true,
-    "esModuleInterop": true,
-    "module": "esnext",
-    "moduleResolution": "bundler",
-    "resolveJsonModule": true,
-    "isolatedModules": true,
-    "jsx": "react-jsx",
-    "incremental": true,
-    "paths": {
-      "@/*": ["./*"],
-      "fumadocs-mdx:collections/*": [".source/*"]
-    },
-    "plugins": [{ "name": "next" }]
-  },
-  "include": [
-    "next-env.d.ts",
-    "**/*.ts",
-    "**/*.tsx",
-    ".next/types/**/*.ts",
-    ".next/dev/types/**/*.ts"
-  ],
-  "exclude": ["node_modules"]
-}