fix: Resolve Vercel schema loading and CI path issues

Author: fabiendostie

lib/api-client.ts

@@ -21,11 +21,14 @@ interface SchemaPropertyDetails {
  * Gets the base URL for API requests, adjusting for GitHub Pages in production
  */
 const getApiBase = () => {
-  // In production (GitHub Pages), use static JSON files in the /api directory
-  if (process.env.NODE_ENV === "production") {
+  // Determine if this is a GitHub Pages specific build
+  const isGithubPagesBuild = process.env.GITHUB_PAGES_BUILD === 'true';
+
+  // Use GitHub Pages path ONLY when specifically building for GitHub Pages
+  if (isGithubPagesBuild) {
     return "/JSON_Schema_Validator/api";
   }
-  // In development, use the dynamic API routes
+  // In all other cases (development, Vercel, CI tests, standard prod builds)
   return "/api";
 };
 
@@ -63,12 +66,18 @@ export async function getSchemaByName(
     .replace(/\.json$/, "")
     .replace(/[^\w-]/g, "");
 
-  // In development, fetch directly from public folder
-  // In production, fetch the static JSON generated by the build script
-  const url =
-    process.env.NODE_ENV === "production"
-      ? `${getApiBase()}/schemas/${safeSchemaName}.json` // Prod URL remains the same (fetches from public/api/schemas)
-      : `/schemas/v1/${safeSchemaName}.json`; // Changed dev URL (fetches from public/schemas/v1)
+  // Determine the correct URL based on environment
+  const isGithubPagesBuild = process.env.GITHUB_PAGES_BUILD === 'true';
+  const isProduction = process.env.NODE_ENV === 'production';
+
+  // Use static paths for GitHub Pages build, dynamic API otherwise
+  const url = isGithubPagesBuild
+    ? `${getApiBase()}/schemas/${safeSchemaName}.json` // /JSON_Schema_Validator/api/schemas/...json
+    : isProduction
+      ? `/api/get-schema/${safeSchemaName}` // Use API route in regular production (Vercel)
+      : `/schemas/v1/${safeSchemaName}.json`; // Dev fetches directly from public/schemas/v1
+
+  console.log(`[getSchemaByName] Fetching schema from URL: ${url}`); // Debug logging
 
   try {
     const response = await fetch(url);
@@ -137,8 +146,14 @@ function generateClientSideMarkdown(schema: Record<string, unknown>): string {
 export async function generateSchemaDocumentation(
   schema: Record<string, unknown>,
 ): Promise<{ markdown: string }> {
-  // In production, generate markdown on the client side
-  if (process.env.NODE_ENV === "production") {
+  // Generate on client side if building for GitHub Pages or in production (Vercel)
+  const isClientSideGeneration =
+    process.env.GITHUB_PAGES_BUILD === 'true' || process.env.NODE_ENV === "production";
+
+  if (isClientSideGeneration) {
+    console.log(
+      "Generating schema documentation on the client side (Prod/GitHub Pages)",
+    );
     try {
       return { markdown: generateClientSideMarkdown(schema) };
     } catch (error) {
@@ -153,6 +168,7 @@ export async function generateSchemaDocumentation(
   }
 
   // In development, try the API endpoint first, fallback to client-side if unavailable
+  console.log("Attempting to generate schema documentation via API (Dev)");
   try {
     // Use the absolute path to ensure the request works correctly
     const url = "/api/generate-schema-doc";

next.config.mjs

@@ -7,18 +7,15 @@ try {
   // ignore error
 }
 
+// Determine if this build is specifically for GitHub Pages static export
+const isGithubPagesBuild = process.env.GITHUB_PAGES_BUILD === 'true';
+
 /** @type {import('next').NextConfig} */
 const nextConfig = {
   // Configure basePath and assetPrefix conditionally
-  // Use basePath for GitHub Pages only in production & when VERCEL is not set
-  basePath:
-    process.env.NODE_ENV === "production" && !process.env.VERCEL
-      ? "/JSON_Schema_Validator"
-      : "",
-  assetPrefix:
-    process.env.NODE_ENV === "production" && !process.env.VERCEL
-      ? "/JSON_Schema_Validator/"
-      : "/",
+  // Use basePath only for GitHub Pages builds
+  basePath: isGithubPagesBuild ? "/JSON_Schema_Validator" : "",
+  assetPrefix: isGithubPagesBuild ? "/JSON_Schema_Validator/" : "/",
 
   // Add eslint configuration to ignore during builds
   eslint: {