compatibility-matrix.ts

/**
 * @data/rules/compatibility-matrix.ts
 * Rule-based compatibility definitions.
 * Every rule maps a combination of stack choices to a compatibility status.
 * The engine reads these — never duplicate this logic in UI or CLI code.
 */

import type {
  Framework,
  Database,
  ORM,
  AuthProvider,
  UILibrary,
  CompatibilityStatus,
} from "../schemas/stack";

export interface CompatibilityRule {
  key: string;
  status: CompatibilityStatus;
  message: string;
  suggestion?: string;
}

// ─── Framework + UI Library ───────────────────────────────────────────────

export type FrameworkUIRule = {
  framework: Framework;
  uiLibrary: UILibrary;
} & CompatibilityRule;

export const FRAMEWORK_UI_RULES: FrameworkUIRule[] = [
  // shadcn/ui is React-only
  {
    key: "framework-ui",
    framework: "astro",
    uiLibrary: "shadcn",
    status: "needs-review",
    message: "shadcn/ui works in Astro via React integration but requires @astrojs/react",
    suggestion: "Install @astrojs/react or switch uiLibrary to 'none' for Astro",
  },
  {
    key: "framework-ui",
    framework: "sveltekit",
    uiLibrary: "shadcn",
    status: "incompatible",
    message: "shadcn/ui is React-only and cannot be used with SvelteKit",
    suggestion: "Use 'none' or a Svelte-native component library",
  },
  {
    key: "framework-ui",
    framework: "nuxt",
    uiLibrary: "shadcn",
    status: "incompatible",
    message: "shadcn/ui is React-only and cannot be used with Nuxt",
    suggestion: "Use 'none' for Nuxt or switch to a Vue-compatible library",
  },
  {
    key: "framework-ui",
    framework: "hono",
    uiLibrary: "shadcn",
    status: "incompatible",
    message: "Hono is a server framework; shadcn/ui is a client component library",
    suggestion: "Remove uiLibrary for API projects or add a frontend separately",
  },
  {
    key: "framework-ui",
    framework: "express",
    uiLibrary: "shadcn",
    status: "incompatible",
    message: "Express is a server framework; shadcn/ui is a client component library",
    suggestion: "Remove uiLibrary for API projects",
  },
  {
    key: "framework-ui",
    framework: "fastify",
    uiLibrary: "shadcn",
    status: "incompatible",
    message: "Fastify is a server framework; shadcn/ui is a client component library",
    suggestion: "Remove uiLibrary for API projects",
  },
];

// ─── Database + ORM ───────────────────────────────────────────────────────

export type DatabaseORMRule = {
  database: Database;
  orm: ORM;
} & CompatibilityRule;

export const DATABASE_ORM_RULES: DatabaseORMRule[] = [
  // Convex has its own query layer — no external ORM needed
  {
    key: "db-orm",
    database: "convex",
    orm: "prisma",
    status: "incompatible",
    message: "Convex has its own built-in data layer and does not use Prisma",
    suggestion: "Set orm to 'none' when using Convex",
  },
  {
    key: "db-orm",
    database: "convex",
    orm: "drizzle",
    status: "incompatible",
    message: "Convex has its own built-in data layer and does not use Drizzle",
    suggestion: "Set orm to 'none' when using Convex",
  },
  {
    key: "db-orm",
    database: "convex",
    orm: "mongoose",
    status: "incompatible",
    message: "Convex has its own built-in data layer and does not use Mongoose",
    suggestion: "Set orm to 'none' when using Convex",
  },
  // Supabase has PostgREST built in; Prisma/Drizzle work on top
  {
    key: "db-orm",
    database: "supabase",
    orm: "mongoose",
    status: "incompatible",
    message: "Supabase uses PostgreSQL; Mongoose is for MongoDB",
    suggestion: "Use Prisma or Drizzle with Supabase, or set orm to 'none'",
  },
  // MongoDB needs Mongoose
  {
    key: "db-orm",
    database: "mongodb",
    orm: "prisma",
    status: "needs-review",
    message: "Prisma supports MongoDB but the MongoDB connector has limitations",
    suggestion: "Consider using Mongoose for better MongoDB compatibility",
  },
  {
    key: "db-orm",
    database: "mongodb",
    orm: "drizzle",
    status: "incompatible",
    message: "Drizzle does not support MongoDB",
    suggestion: "Use Mongoose for MongoDB, or switch to a PostgreSQL-based database",
  },
  // Firebase has its own SDK
  {
    key: "db-orm",
    database: "firebase",
    orm: "prisma",
    status: "incompatible",
    message: "Firebase Firestore uses its own SDK and does not work with Prisma",
    suggestion: "Set orm to 'none' when using Firebase",
  },
  {
    key: "db-orm",
    database: "firebase",
    orm: "drizzle",
    status: "incompatible",
    message: "Firebase Firestore uses its own SDK and does not work with Drizzle",
    suggestion: "Set orm to 'none' when using Firebase",
  },
  // No DB = no ORM
  {
    key: "db-orm",
    database: "none",
    orm: "prisma",
    status: "incompatible",
    message: "An ORM requires a database. No database is selected.",
    suggestion: "Select a database or set orm to 'none'",
  },
  {
    key: "db-orm",
    database: "none",
    orm: "drizzle",
    status: "incompatible",
    message: "An ORM requires a database. No database is selected.",
    suggestion: "Select a database or set orm to 'none'",
  },
  {
    key: "db-orm",
    database: "none",
    orm: "mongoose",
    status: "incompatible",
    message: "An ORM requires a database. No database is selected.",
    suggestion: "Select a database or set orm to 'none'",
  },
];

// ─── Auth + Framework ─────────────────────────────────────────────────────

export type AuthFrameworkRule = {
  auth: AuthProvider;
  framework: Framework;
} & CompatibilityRule;

export const AUTH_FRAMEWORK_RULES: AuthFrameworkRule[] = [
  // next-auth is Next.js specific
  {
    key: "auth-framework",
    auth: "next-auth",
    framework: "react-vite",
    status: "incompatible",
    message: "next-auth (Auth.js) requires a Next.js or compatible server framework",
    suggestion: "Use better-auth or clerk for Vite React projects",
  },
  {
    key: "auth-framework",
    auth: "next-auth",
    framework: "astro",
    status: "needs-review",
    message: "Auth.js has an Astro adapter but requires additional configuration",
    suggestion: "Use better-auth for simpler Astro auth setup",
  },
  {
    key: "auth-framework",
    auth: "next-auth",
    framework: "hono",
    status: "incompatible",
    message: "next-auth is designed for Next.js and is incompatible with Hono",
    suggestion: "Use better-auth which supports Hono via its adapter system",
  },
  // Supabase auth goes with Supabase DB
  {
    key: "auth-framework",
    auth: "supabase-auth",
    framework: "hono",
    status: "needs-review",
    message: "Supabase Auth works with Hono but requires manual JWT validation setup",
    suggestion: "Consider better-auth for a more integrated Hono auth experience",
  },
];

// ─── Database + Auth ─────────────────────────────────────────────────────

export type DatabaseAuthRule = {
  database: Database;
  auth: AuthProvider;
} & CompatibilityRule;

export const DATABASE_AUTH_RULES: DatabaseAuthRule[] = [
  {
    key: "db-auth",
    database: "firebase",
    auth: "better-auth",
    status: "needs-review",
    message: "better-auth with Firebase requires a custom adapter",
    suggestion: "Use firebase-auth when working with Firebase, or switch to PostgreSQL/Supabase",
  },
  {
    key: "db-auth",
    database: "convex",
    auth: "better-auth",
    status: "needs-review",
    message: "better-auth with Convex requires a custom adapter — not officially supported yet",
    suggestion: "Use Clerk which has official Convex integration, or use Supabase Auth",
  },
  {
    key: "db-auth",
    database: "convex",
    auth: "next-auth",
    status: "needs-review",
    message: "next-auth with Convex requires a custom session/token setup",
    suggestion: "Use Clerk which has official Convex integration",
  },
];