@xyd-js/plugin-docs 0.0.0-build-1760f84-20251129221538 → 0.0.0-build-11974d8-20251130234931

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyd-js/plugin-docs",
-  "version": "0.0.0-build-1760f84-20251129221538",
+  "version": "0.0.0-build-11974d8-20251130234931",
   "description": "",
   "type": "module",
   "main": "dist/index.js",
@@ -18,10 +18,10 @@
     "codehike": "^1.0.3",
     "@code-hike/lighter": "^1.0.3",
     "dotenv": "^16.4.7",
-    "@xyd-js/openapi": "0.0.0-build-1760f84-20251129221538",
-    "@xyd-js/gql": "0.0.0-build-1760f84-20251129221538",
-    "@xyd-js/uniform": "0.0.0-build-1760f84-20251129221538",
-    "@xyd-js/sources": "0.0.0-build-1760f84-20251129221538",
+    "@xyd-js/openapi": "0.0.0-build-11974d8-20251130234931",
+    "@xyd-js/gql": "0.0.0-build-11974d8-20251130234931",
+    "@xyd-js/uniform": "0.0.0-build-11974d8-20251130234931",
+    "@xyd-js/sources": "0.0.0-build-11974d8-20251130234931",
     "@xyd-js/cli-sdk": "0.1.0-build.0"
   },
   "peerDependencies": {
@@ -32,12 +32,12 @@
     "react": "^19.1.0",
     "react-dom": "^19.1.0",
     "react-router": "^7.7.1",
-    "@xyd-js/framework": "0.0.0-build-1760f84-20251129221538",
-    "@xyd-js/composer": "0.0.0-build-1760f84-20251129221538",
-    "@xyd-js/themes": "0.0.0-build-1760f84-20251129221538",
-    "@xyd-js/components": "0.0.0-build-1760f84-20251129221538",
-    "@xyd-js/content": "0.0.0-build-1760f84-20251129221538",
-    "@xyd-js/core": "0.0.0-build-1760f84-20251129221538"
+    "@xyd-js/framework": "0.0.0-build-11974d8-20251130234931",
+    "@xyd-js/composer": "0.0.0-build-11974d8-20251130234931",
+    "@xyd-js/themes": "0.0.0-build-11974d8-20251130234931",
+    "@xyd-js/components": "0.0.0-build-11974d8-20251130234931",
+    "@xyd-js/content": "0.0.0-build-11974d8-20251130234931",
+    "@xyd-js/core": "0.0.0-build-11974d8-20251130234931"
   },
   "devDependencies": {
     "@types/react-dom": "^19.1.0",

package/src/presets/docs/settings.ts

@@ -35,127 +35,127 @@ const extensions = ["tsx", "ts", "json"];
  * @throws May throw errors if file reading or parsing fails
  */
 export async function readSettings() {
-  const dirPath = process.cwd();
-
-  // Load environment variables from .env files first
-  await loadEnvFiles(dirPath);
-
-  const baseFileName = "docs";
-  let settingsFilePath = "";
-  let reactSettings = false;
-
-  let error: string | null = null;
-  try {
-    const files = await fs.readdir(dirPath);
-    const settingsFile = files.find((file) => {
-      const ext = path.extname(file).slice(1);
-      return file.startsWith(baseFileName) && extensions.includes(ext);
-    });
-
-    if (settingsFile) {
-      settingsFilePath = path.join(dirPath, settingsFile);
-      reactSettings = path.extname(settingsFile) !== ".json";
-    } else {
-      error =
-        "No settings file found.\nFile must be named 'docs' with one of the following extensions: ${extensions.join(', ')}";
-    }
-  } catch (error) {
-    console.error(error);
-    return null;
-  }
+    const dirPath = process.cwd();
 
-  let settings: Settings | null = null;
-
-  if (!error) {
-    if (reactSettings) {
-      const settingsPreview = await createServer({
-        optimizeDeps: {
-          include: ["react/jsx-runtime"],
-        },
-      });
-      const config = await settingsPreview.ssrLoadModule(settingsFilePath);
-      const mod = config.default as Settings;
+    // Load environment variables from .env files first
+    await loadEnvFiles(dirPath);
 
-      settings = postLoadSetup(mod);
-    } else {
-      const rawJsonSettings = await fs.readFile(settingsFilePath, "utf-8");
-      try {
-        let json = JSON.parse(rawJsonSettings) as Settings;
+    const baseFileName = "docs";
+    let settingsFilePath = "";
+    let reactSettings = false;
 
-        settings = postLoadSetup(json);
-      } catch (e) {
-        console.error("⚠️ Error parsing settings file");
+    let error: string | null = null;
+    try {
+        const files = await fs.readdir(dirPath);
+        const settingsFile = files.find((file) => {
+            const ext = path.extname(file).slice(1);
+            return file.startsWith(baseFileName) && extensions.includes(ext);
+        });
 
+        if (settingsFile) {
+            settingsFilePath = path.join(dirPath, settingsFile);
+            reactSettings = path.extname(settingsFile) !== ".json";
+        } else {
+            error =
+                "No settings file found.\nFile must be named 'docs' with one of the following extensions: ${extensions.join(', ')}";
+        }
+    } catch (error) {
+        console.error(error);
         return null;
-      }
     }
-  }
 
-  const fastServeSettings = await fastServeSetup(settings);
-  if (fastServeSettings) {
-    return fastServeSettings;
-  }
+    let settings: Settings | null = null;
+
+    if (!error) {
+        if (reactSettings) {
+            const settingsPreview = await createServer({
+                optimizeDeps: {
+                    include: ["react/jsx-runtime"],
+                },
+            });
+            const config = await settingsPreview.ssrLoadModule(settingsFilePath);
+            const mod = config.default as Settings;
+
+            settings = postLoadSetup(mod);
+        } else {
+            const rawJsonSettings = await fs.readFile(settingsFilePath, "utf-8");
+            try {
+                let json = JSON.parse(rawJsonSettings) as Settings;
+
+                settings = postLoadSetup(json);
+            } catch (e) {
+                console.error("⚠️ Error parsing settings file");
+
+                return null;
+            }
+        }
+    }
+
+    const fastServeSettings = await fastServeSetup(settings);
+    if (fastServeSettings) {
+        return fastServeSettings;
+    }
 
-  return settings;
+    return settings;
 }
 
 // TODO: it's concept only
 async function fastServeSetup(currentSettings: Settings | null) {
-  const args = process.argv.slice(2);
-  const [command, optionalFastServePath] = args;
+    const args = process.argv.slice(2);
+    const [command, optionalFastServePath] = args;
 
-  const fastServeMode =
-    (command === "dev" || command === "build") && optionalFastServePath;
-  if (!fastServeMode) {
-    return null;
-  }
-
-  const extension = path.extname(optionalFastServePath).slice(1);
-
-  let fastServeSettings: Settings = {
-    theme: {
-      name: "gusto",
-      appearance: {
-        //@ts-ignore
-        search: false,
-        colorScheme: false,
-      },
-    },
-  };
-  if (currentSettings) {
-    fastServeSettings = deepMerge(fastServeSettings, currentSettings);
-  }
-
-  switch (extension) {
-    case "yaml":
-    case "yml": {
-      if (await isOpenApiYaml(optionalFastServePath)) {
-        fastServeSettings.api = {
-          openapi: optionalFastServePath,
-        };
+    const fastServeMode =
+        (command === "dev" || command === "build") && optionalFastServePath;
+    if (!fastServeMode) {
+        return null;
+    }
 
-        return postLoadSetup(fastServeSettings);
-      }
+    const extension = path.extname(optionalFastServePath).slice(1);
+
+    let fastServeSettings: Settings = {
+        theme: {
+            name: "gusto",
+            appearance: {
+                //@ts-ignore
+                search: false,
+                colorScheme: false,
+            },
+        },
+    };
+    if (currentSettings) {
+        fastServeSettings = deepMerge(fastServeSettings, currentSettings);
     }
-    case "graphql":
-    case "graphqls": {
-      fastServeSettings.api = {
-        graphql: optionalFastServePath,
-      };
 
-      return postLoadSetup(fastServeSettings);
+    switch (extension) {
+        case "yaml":
+        case "yml": {
+            if (await isOpenApiYaml(optionalFastServePath)) {
+                fastServeSettings.api = {
+                    openapi: optionalFastServePath,
+                };
+
+                return postLoadSetup(fastServeSettings);
+            }
+        }
+        case "graphql":
+        case "graphqls": {
+            fastServeSettings.api = {
+                graphql: optionalFastServePath,
+            };
+
+            return postLoadSetup(fastServeSettings);
+        }
     }
-  }
 
-  return null;
+    return null;
 }
 
 function postLoadSetup(settings: Settings) {
-  // Replace environment variables in the settings
-  const processedSettings = replaceEnvVars(settings);
-  presets(processedSettings);
+    // Replace environment variables in the settings
+    const processedSettings = replaceEnvVars(settings);
+    presets(processedSettings);
 
-  return processedSettings;
+    return processedSettings;
 }
 
 // if (settings?.theme?.coder?.syntaxHighlight) {
@@ -163,106 +163,113 @@ function postLoadSetup(settings: Settings) {
 // }
 
 function presets(settings: Settings) {
-  if (
-    settings?.theme?.coder?.syntaxHighlight &&
-    typeof settings.theme.coder.syntaxHighlight === "string"
-  ) {
-    handleSyntaxHighlight(settings.theme.coder.syntaxHighlight, settings);
-  }
-  ensureNavigation(settings);
-
-  if (settings?.theme && !settings?.theme?.head?.length) {
-    settings.theme.head = [];
-  }
-
-  ensureBasename(settings);
+    if (
+        settings?.theme?.coder?.syntaxHighlight &&
+        typeof settings.theme.coder.syntaxHighlight === "string"
+    ) {
+        handleSyntaxHighlight(settings.theme.coder.syntaxHighlight, settings);
+    }
+    ensureNavigation(settings);
+
+    if (settings?.theme && !settings?.theme?.head?.length) {
+        settings.theme.head = [];
+    }
+
+    ensureBasename(settings);
+
+    if (typeof settings?.integrations?.diagrams === "boolean" && settings?.integrations?.diagrams) {
+        // by default, enable mermaid only
+        settings.integrations.diagrams = [
+            "mermaid",
+        ]
+    }
 }
 
 function ensureBasename(settings: Settings) {
-  const basename = settings?.advanced?.basename;
-  if (!basename) {
-    return;
-  }
-  if (typeof settings?.theme?.logo === "string") {
-    settings.theme.logo = path.join(basename, settings?.theme?.logo);
-  }
-  if (
-    typeof settings?.theme?.logo === "object" &&
-    ("light" in settings?.theme?.logo ||
-      "dark" in settings?.theme?.logo ||
-      "href" in settings?.theme?.logo)
-  ) {
-    settings.theme.logo = {
-      light: path.join(basename, settings?.theme?.logo?.light || ""),
-      dark: path.join(basename, settings?.theme?.logo?.dark || ""),
-      href: settings?.theme?.logo?.href,
-    };
-  }
-  if (typeof settings?.theme?.favicon === "string") {
-    settings.theme.favicon = path.join(basename, settings?.theme?.favicon);
-  }
+    const basename = settings?.advanced?.basename;
+    if (!basename) {
+        return;
+    }
+    if (typeof settings?.theme?.logo === "string") {
+        settings.theme.logo = path.join(basename, settings?.theme?.logo);
+    }
+    if (
+        typeof settings?.theme?.logo === "object" &&
+        ("light" in settings?.theme?.logo ||
+            "dark" in settings?.theme?.logo ||
+            "href" in settings?.theme?.logo)
+    ) {
+        settings.theme.logo = {
+            light: path.join(basename, settings?.theme?.logo?.light || ""),
+            dark: path.join(basename, settings?.theme?.logo?.dark || ""),
+            href: settings?.theme?.logo?.href,
+        };
+    }
+    if (typeof settings?.theme?.favicon === "string") {
+        settings.theme.favicon = path.join(basename, settings?.theme?.favicon);
+    }
 }
 
 async function handleSyntaxHighlight(
-  syntaxHighlight: string,
-  settings: Settings
+    syntaxHighlight: string,
+    settings: Settings
 ) {
-  try {
-    // Ensure theme.coder exists
-    if (!settings.theme) {
-      settings.theme = { name: "default" } as any;
-    }
-    if (!settings.theme!.coder) {
-      settings.theme!.coder = {};
-    }
-
-    // Check if it's a URL
-    if (isUrl(syntaxHighlight)) {
-      // Fetch from remote URL
-      const response = await fetch(syntaxHighlight);
-      if (!response.ok) {
-        console.error(
-          `⚠️ Failed to fetch syntax highlight from URL: ${syntaxHighlight}`
-        );
-        return;
-      }
-      const json = await response.json();
-      settings.theme!.coder!.syntaxHighlight = json;
-    } else {
-      // Handle local path - but first check if ita's actually a path
-      const localPath = path.resolve(process.cwd(), syntaxHighlight);
-      try {
-        // Check if the file exists before trying to read it
-        await fs.access(localPath);
-        const fileContent = await fs.readFile(localPath, "utf-8");
-        const json = JSON.parse(fileContent);
-        settings.theme!.coder!.syntaxHighlight = json;
-      } catch (error) {}
-    }
+    try {
+        // Ensure theme.coder exists
+        if (!settings.theme) {
+            settings.theme = { name: "default" } as any;
+        }
+        if (!settings.theme!.coder) {
+            settings.theme!.coder = {};
+        }
 
-    const syntaxHighlightTheme = settings.theme?.coder?.syntaxHighlight;
-    if (syntaxHighlightTheme) {
-      try {
-        const themeColors = await getThemeColors(syntaxHighlightTheme);
+        // Check if it's a URL
+        if (isUrl(syntaxHighlight)) {
+            // Fetch from remote URL
+            const response = await fetch(syntaxHighlight);
+            if (!response.ok) {
+                console.error(
+                    `⚠️ Failed to fetch syntax highlight from URL: ${syntaxHighlight}`
+                );
+                return;
+            }
+            const json = await response.json();
+            settings.theme!.coder!.syntaxHighlight = json;
+        } else {
+            // Handle local path - but first check if ita's actually a path
+            const localPath = path.resolve(process.cwd(), syntaxHighlight);
+            try {
+                // Check if the file exists before trying to read it
+                await fs.access(localPath);
+                const fileContent = await fs.readFile(localPath, "utf-8");
+                const json = JSON.parse(fileContent);
+                settings.theme!.coder!.syntaxHighlight = json;
+            } catch (error) {}
+        }
 
-        if (themeColors) {
-          globalThis.__xydUserPreferences = {
-            themeColors,
-          };
+        const syntaxHighlightTheme = settings.theme?.coder?.syntaxHighlight;
+        if (syntaxHighlightTheme) {
+            try {
+                const themeColors = await getThemeColors(syntaxHighlightTheme);
+
+                if (themeColors) {
+                    globalThis.__xydUserPreferences = {
+                        themeColors,
+                    };
+                }
+            } catch (error) {
+                console.error(
+                    `⚠️ Error processing syntax highlight theme colors.`,
+                    error
+                );
+            }
         }
-      } catch (error) {
+    } catch (error) {
         console.error(
-          `⚠️ Error processing syntax highlight theme colors.`,
-          error
+            `⚠️ Error processing syntax highlight: ${syntaxHighlight}`,
+            error
         );
-      }
     }
-  } catch (error) {
-    console.error(
-      `⚠️ Error processing syntax highlight: ${syntaxHighlight}`,
-      error
-    );
-  }
 }
 
 /**
@@ -270,105 +277,105 @@ async function handleSyntaxHighlight(
  * @param dirPath - The directory path to search for .env files
  */
 async function loadEnvFiles(dirPath: string) {
-  try {
-    // Define the order of .env files to load (later files override earlier ones)
-    const envFiles = [
-      ".env",
-      ".env.local",
-      ".env.development",
-      ".env.production",
-    ];
-
-    for (const envFile of envFiles) {
-      const envPath = path.join(dirPath, envFile);
-
-      try {
-        await fs.access(envPath);
-        const result = dotenvConfig({
-          path: envPath,
-          override: true, // Ensure variables are overridden
-        });
-
-        if (result.parsed && Object.keys(result.parsed).length > 0) {
-          console.debug(`📄 Loaded environment variables.`);
+    try {
+        // Define the order of .env files to load (later files override earlier ones)
+        const envFiles = [
+            ".env",
+            ".env.local",
+            ".env.development",
+            ".env.production",
+        ];
+
+        for (const envFile of envFiles) {
+            const envPath = path.join(dirPath, envFile);
+
+            try {
+                await fs.access(envPath);
+                const result = dotenvConfig({
+                    path: envPath,
+                    override: true, // Ensure variables are overridden
+                });
+
+                if (result.parsed && Object.keys(result.parsed).length > 0) {
+                    console.debug(`📄 Loaded environment variables.`);
+                }
+            } catch (error) {
+                // File doesn't exist, which is fine - continue to next file
+            }
         }
-      } catch (error) {
-        // File doesn't exist, which is fine - continue to next file
-      }
+    } catch (error) {
+        console.warn("⚠️ Error loading .env files:", error);
     }
-  } catch (error) {
-    console.warn("⚠️ Error loading .env files:", error);
-  }
 }
 
 
 function isUrl(str: string): boolean {
-  try {
-    new URL(str);
-    return true;
-  } catch {
-    return false;
-  }
+    try {
+        new URL(str);
+        return true;
+    } catch {
+        return false;
+    }
 }
 
 function ensureNavigation(json: Settings) {
-  if (!json?.webeditor) {
-    json.webeditor = {};
-  }
+    if (!json?.webeditor) {
+        json.webeditor = {};
+    }
 
-  if (!json?.navigation) {
-    json.navigation = {
-      sidebar: [],
-    };
-  }
+    if (!json?.navigation) {
+        json.navigation = {
+            sidebar: [],
+        };
+    }
 
-  if (!json?.navigation?.sidebar) {
-    json.navigation.sidebar = [];
-  }
+    if (!json?.navigation?.sidebar) {
+        json.navigation.sidebar = [];
+    }
 }
 
 type DeepPartial<T> = {
-  [P in keyof T]?: T[P] extends object
-    ? T[P] extends Function
-      ? T[P]
-      : T[P] extends Array<infer U>
-        ? Array<DeepPartial<U>>
-        : DeepPartial<T[P]>
-    : T[P];
+    [P in keyof T]?: T[P] extends object
+        ? T[P] extends Function
+            ? T[P]
+            : T[P] extends Array<infer U>
+                ? Array<DeepPartial<U>>
+                : DeepPartial<T[P]>
+        : T[P];
 };
 
 function deepMerge<T>(target: T, source: DeepPartial<T>): T {
-  for (const key in source) {
-    const sourceVal = source[key];
-    const targetVal = target[key];
-
-    if (
-      sourceVal &&
-      typeof sourceVal === "object" &&
-      !Array.isArray(sourceVal) &&
-      typeof targetVal === "object" &&
-      targetVal !== null
-    ) {
-      target[key] = deepMerge(targetVal, sourceVal);
-    } else if (sourceVal !== undefined) {
-      target[key] = sourceVal as any;
+    for (const key in source) {
+        const sourceVal = source[key];
+        const targetVal = target[key];
+
+        if (
+            sourceVal &&
+            typeof sourceVal === "object" &&
+            !Array.isArray(sourceVal) &&
+            typeof targetVal === "object" &&
+            targetVal !== null
+        ) {
+            target[key] = deepMerge(targetVal, sourceVal);
+        } else if (sourceVal !== undefined) {
+            target[key] = sourceVal as any;
+        }
     }
-  }
 
-  return target;
+    return target;
 }
 
 async function isOpenApiYaml(filePath: string): Promise<boolean> {
-  try {
-    const content = await fs.readFile(filePath, "utf-8");
-    const parsed = yaml.load(content);
-    if (!parsed) {
-      return false;
-    }
+    try {
+        const content = await fs.readFile(filePath, "utf-8");
+        const parsed = yaml.load(content);
+        if (!parsed) {
+            return false;
+        }
 
-    return parsed && typeof parsed === "object" && "openapi" in parsed;
-  } catch (error) {
-    console.warn(`⚠️ Error reading or parsing YAML file ${filePath}:`, error);
-    return false;
-  }
+        return parsed && typeof parsed === "object" && "openapi" in parsed;
+    } catch (error) {
+        console.warn(`⚠️ Error reading or parsing YAML file ${filePath}:`, error);
+        return false;
+    }
 }