convex-cms 0.0.2 → 0.0.5-alpha.0

package/src/cli/commands/admin.ts

@@ -1,104 +0,0 @@
-import path from "path";
-import { fileURLToPath } from "url";
-import { detectConvexUrl } from "../utils/detectConvexUrl.js";
-import { openBrowser } from "../utils/openBrowser.js";
-
-interface AdminOptions {
-  url?: string;
-  port: string;
-  demo?: boolean;
-  open: boolean;
-}
-
-/**
- * Launch the Convex CMS admin panel.
- *
- * This command starts a pre-built TanStack Start server that serves the
- * admin UI. The server reads CONVEX_URL from the environment at runtime,
- * allowing a single build to connect to any Convex deployment.
- */
-export async function adminCommand(options: AdminOptions): Promise<void> {
-  // 1. Resolve Convex URL
-  const convexUrl = options.url ?? (await detectConvexUrl());
-
-  if (!convexUrl && !options.demo) {
-    console.error("Error: Could not detect Convex deployment URL.");
-    console.error("");
-    console.error("Please provide the URL using one of these methods:");
-    console.error("  --url <url>           Pass URL directly");
-    console.error("  CONVEX_URL=<url>      Set environment variable");
-    console.error("  .env.local            Add CONVEX_URL to env file");
-    console.error("");
-    console.error("Or run in demo mode with mock data:");
-    console.error("  npx convex-cms admin --demo");
-    process.exit(1);
-  }
-
-  // 2. Set environment variables for the server
-  if (convexUrl) {
-    process.env.CONVEX_URL = convexUrl;
-  }
-  process.env.AUTH_MODE = options.demo ? "demo" : "production";
-  process.env.PORT = options.port;
-  process.env.NITRO_PORT = options.port;
-
-  // 3. Find the pre-built admin assets
-  // When compiled, this file is at dist/cli/commands/admin.js
-  // We need to go up 3 levels to reach admin-dist at the package root
-  const __dirname = path.dirname(fileURLToPath(import.meta.url));
-  const adminDistPath = path.resolve(__dirname, "../../../admin-dist");
-
-  // 4. Log startup info
-  console.log("");
-  console.log("  Convex CMS Admin");
-  console.log("  ----------------");
-  if (convexUrl) {
-    console.log(`  Convex URL: ${convexUrl}`);
-  } else {
-    console.log("  Convex URL: Not configured (demo mode)");
-  }
-  console.log(`  Port:       ${options.port}`);
-  console.log(`  Auth Mode:  ${options.demo ? "demo" : "production"}`);
-  console.log("");
-
-  // 5. Start the server
-  const serverEntry = path.join(adminDistPath, "server", "index.mjs");
-
-  try {
-    // Dynamically import the server to start it
-    await import(serverEntry);
-
-    // 6. Open browser after server starts
-    const adminUrl = `http://localhost:${options.port}`;
-    if (options.open) {
-      // Give the server a moment to start before opening browser
-      setTimeout(() => {
-        openBrowser(adminUrl);
-      }, 1000);
-    }
-
-    console.log(`  Admin panel starting at ${adminUrl}`);
-    console.log("");
-    console.log("  Press Ctrl+C to stop");
-    console.log("");
-  } catch (error) {
-    if (
-      error instanceof Error &&
-      error.message.includes("Cannot find module")
-    ) {
-      console.error("Error: Admin build not found.");
-      console.error("");
-      console.error(
-        "The pre-built admin UI is missing. This usually means:"
-      );
-      console.error("  - You're running from source (not the npm package)");
-      console.error("  - The package wasn't built correctly");
-      console.error("");
-      console.error("If developing locally, run:");
-      console.error("  cd admin && npm run dev");
-    } else {
-      console.error("Error starting admin server:", error);
-    }
-    process.exit(1);
-  }
-}

package/src/cli/index.ts

@@ -1,21 +0,0 @@
-#!/usr/bin/env node
-import { Command } from "commander";
-import { adminCommand } from "./commands/admin.js";
-
-const program = new Command();
-
-program
-  .name("convex-cms")
-  .description("Convex CMS CLI - Headless CMS built on Convex")
-  .version("0.0.1");
-
-program
-  .command("admin")
-  .description("Launch the Convex CMS admin panel")
-  .option("--url <url>", "Convex deployment URL")
-  .option("--port <port>", "Port to serve admin on", "3000")
-  .option("--demo", "Run in demo mode with mock authentication")
-  .option("--no-open", "Do not open browser automatically")
-  .action(adminCommand);
-
-program.parse();

package/src/cli/utils/detectConvexUrl.ts

@@ -1,54 +0,0 @@
-import fs from "fs";
-import path from "path";
-
-/**
- * Detects the Convex deployment URL from various sources.
- *
- * Priority order:
- * 1. CONVEX_URL environment variable
- * 2. VITE_CONVEX_URL environment variable
- * 3. .env.local file in current directory
- * 4. .env file in current directory
- *
- * @returns The detected Convex URL or null if not found
- */
-export async function detectConvexUrl(): Promise<string | null> {
-  // Check environment variables first
-  if (process.env.CONVEX_URL) {
-    return process.env.CONVEX_URL;
-  }
-
-  if (process.env.VITE_CONVEX_URL) {
-    return process.env.VITE_CONVEX_URL;
-  }
-
-  // Try to read from env files in the current working directory
-  const envFiles = [".env.local", ".env"];
-
-  for (const envFile of envFiles) {
-    const envPath = path.join(process.cwd(), envFile);
-
-    if (fs.existsSync(envPath)) {
-      try {
-        const content = fs.readFileSync(envPath, "utf-8");
-
-        // Look for CONVEX_URL or VITE_CONVEX_URL
-        const patterns = [
-          /^CONVEX_URL=["']?([^"'\n\r]+)["']?/m,
-          /^VITE_CONVEX_URL=["']?([^"'\n\r]+)["']?/m,
-        ];
-
-        for (const pattern of patterns) {
-          const match = content.match(pattern);
-          if (match?.[1]) {
-            return match[1].trim();
-          }
-        }
-      } catch {
-        // Ignore read errors, continue to next file
-      }
-    }
-  }
-
-  return null;
-}

package/src/cli/utils/openBrowser.ts

@@ -1,16 +0,0 @@
-import open from "open";
-
-/**
- * Opens a URL in the default browser.
- *
- * @param url - The URL to open
- */
-export async function openBrowser(url: string): Promise<void> {
-  try {
-    await open(url);
-  } catch (_error) {
-    // Silently fail if browser cannot be opened
-    // The user can still manually navigate to the URL
-    console.warn(`Could not open browser automatically. Please visit: ${url}`);
-  }
-}

package/src/client/admin-config.ts

@@ -1,138 +0,0 @@
-/**
- * Admin UI Configuration Re-exports
- *
- * These utilities allow users to define admin UI configuration
- * in a code-first, type-safe manner.
- *
- * @example
- * // cms-admin.config.ts
- * import { defineAdminConfig } from "@convex-cms/core";
- *
- * export default defineAdminConfig({
- *   branding: {
- *     appName: "My Blog CMS",
- *     logo: "/logo.svg",
- *   },
- *   navigation: {
- *     showTaxonomies: false,
- *     customItems: [
- *       {
- *         id: "analytics",
- *         path: "/analytics",
- *         label: "Analytics",
- *         icon: "BarChart",
- *         section: "main",
- *       },
- *     ],
- *   },
- *   theme: {
- *     mode: "dark",
- *   },
- * });
- */
-
-import { z } from "zod";
-
-export interface NavItem {
-  id: string;
-  path: string;
-  label: string;
-  icon: string;
-  visible?: boolean;
-  section: "main" | "config";
-  badge?: string;
-  exact?: boolean;
-}
-
-const navItemSchema = z.object({
-  id: z.string(),
-  path: z.string(),
-  label: z.string(),
-  icon: z.string(),
-  visible: z.boolean().default(true),
-  section: z.enum(["main", "config"]).default("main"),
-  badge: z.string().optional(),
-  exact: z.boolean().optional(),
-}) satisfies z.ZodType<NavItem>;
-
-const brandingSchema = z.object({
-  appName: z.string().default("Convex CMS"),
-  logo: z.string().optional(),
-  favicon: z.string().optional(),
-});
-
-const layoutSchema = z.object({
-  sidebarWidth: z.number().min(200).max(400).default(256),
-  sidebarCollapsible: z.boolean().default(false),
-});
-
-const navigationSchema = z.object({
-  showDashboard: z.boolean().default(true),
-  showContent: z.boolean().default(true),
-  showMedia: z.boolean().default(true),
-  showTaxonomies: z.boolean().default(true),
-  showContentTypes: z.boolean().default(true),
-  showAuditLogs: z.boolean().default(true),
-  showTrash: z.boolean().default(true),
-  showSettings: z.boolean().default(true),
-  customItems: z.array(navItemSchema).default([]),
-});
-
-const themeSchema = z.object({
-  mode: z.enum(["light", "dark", "system"]).default("system"),
-  allowModeSwitch: z.boolean().default(true),
-  tokens: z.record(z.string(), z.string()).optional(),
-});
-
-export const adminConfigSchema = z.object({
-  branding: brandingSchema.default(() => brandingSchema.parse({})),
-  layout: layoutSchema.default(() => layoutSchema.parse({})),
-  navigation: navigationSchema.default(() => navigationSchema.parse({})),
-  theme: themeSchema.default(() => themeSchema.parse({})),
-});
-
-export type AdminConfig = z.infer<typeof adminConfigSchema>;
-
-/**
- * Define admin UI configuration for your CMS.
- *
- * Use this function in a cms-admin.config.ts file at your project root,
- * or pass the config directly to the <CmsAdmin /> component for embedded mode.
- *
- * @param config - Partial admin configuration (uses sensible defaults)
- * @returns The configuration object (unchanged, for type inference)
- *
- * @example
- * // Code-first config file approach (cms-admin.config.ts)
- * import { defineAdminConfig } from "@convex-cms/core";
- *
- * export default defineAdminConfig({
- *   branding: { appName: "My CMS" },
- *   navigation: { showTaxonomies: false },
- * });
- *
- * @example
- * // Embedded admin approach
- * import { CmsAdmin, defineAdminConfig } from "@convex-cms/admin/embed";
- *
- * const config = defineAdminConfig({
- *   branding: { appName: "My CMS" },
- * });
- *
- * function App() {
- *   return <CmsAdmin config={config} ... />;
- * }
- */
-export function defineAdminConfig(config: Partial<AdminConfig>): Partial<AdminConfig> {
-  return config;
-}
-
-/**
- * Resolve partial admin config with defaults.
- *
- * @param input - Partial configuration
- * @returns Full configuration with all defaults applied
- */
-export function resolveAdminConfig(input?: Partial<AdminConfig>): AdminConfig {
-  return adminConfigSchema.parse(input ?? {});
-}