blodemd 0.0.4 → 0.0.6

package/packages/@repo/previewing/src/index.unit.test.ts

@@ -0,0 +1,290 @@
+import fs from "node:fs/promises";
+import os from "node:os";
+import path from "node:path";
+
+import { afterEach, describe, expect, it } from "vitest";
+
+import {
+  buildUtilityArtifacts,
+  buildSearchIndex,
+  buildContentIndex,
+  buildUtilityIndex,
+  createFsSource,
+  getPrebuiltUtilityLlmPagePath,
+  loadPrebuiltUtilityIndex,
+  loadSiteConfig,
+  PREBUILT_UTILITY_LLMS_FULL_PATH,
+  PREBUILT_UTILITY_LLMS_PATH,
+  PREBUILT_UTILITY_INDEX_PATH,
+  PREBUILT_UTILITY_SITEMAP_PATH,
+  UTILITY_DOCS_ROOT_TOKEN,
+  serializeUtilityIndex,
+} from "./index";
+
+const tempRoots: string[] = [];
+
+const createTempContentRoot = async (files: Record<string, string>) => {
+  const root = await fs.mkdtemp(path.join(os.tmpdir(), "previewing-"));
+  tempRoots.push(root);
+
+  for (const [relativePath, content] of Object.entries(files)) {
+    const absolutePath = path.join(root, relativePath);
+    await fs.mkdir(path.dirname(absolutePath), { recursive: true });
+    await fs.writeFile(absolutePath, content);
+  }
+
+  return root;
+};
+
+afterEach(async () => {
+  await Promise.all(
+    tempRoots.splice(0).map(async (root) => {
+      await fs.rm(root, { force: true, recursive: true });
+    })
+  );
+});
+
+describe("loadSiteConfig", () => {
+  it("loads docs.json as the only supported config file", async () => {
+    const root = await createTempContentRoot({
+      "config/navigation.json": JSON.stringify(
+        {
+          groups: [{ group: "Getting Started", pages: ["index"] }],
+        },
+        null,
+        2
+      ),
+      "docs.json": JSON.stringify(
+        {
+          $schema: "https://mintlify.com/docs.json",
+          api: {
+            openapi: "openapi.yaml",
+            playground: {
+              proxy: true,
+            },
+          },
+          appearance: {
+            strict: true,
+          },
+          colors: {
+            primary: "#171717",
+          },
+          fonts: {
+            family: "Inter",
+          },
+          name: "Example Docs",
+          navbar: {
+            links: [{ href: "https://example.com", label: "Website" }],
+          },
+          navigation: {
+            $ref: "./config/navigation.json",
+          },
+          theme: "mint",
+        },
+        null,
+        2
+      ),
+      "index.mdx": "---\ntitle: Welcome\n---\n",
+    });
+
+    const result = await loadSiteConfig(createFsSource(root));
+
+    expect(result.ok).toBe(true);
+    if (!result.ok) {
+      return;
+    }
+
+    expect(result.warnings).toEqual([]);
+    expect(result.config.name).toBe("Example Docs");
+    expect(result.config.collections).toHaveLength(1);
+    expect(result.config.collections[0]?.openapi).toBe("openapi.yaml");
+    expect(result.config.navigation?.groups).toEqual([
+      { group: "Getting Started", pages: ["index"] },
+    ]);
+    expect(result.config.navigation?.global?.links).toEqual([
+      { href: "https://example.com", label: "Website" },
+    ]);
+    expect(result.config.features?.themeToggle).toBe(false);
+    expect(result.config.openapiProxy?.enabled).toBe(true);
+    expect(result.config.fonts?.cssUrl).toContain("Inter");
+  });
+
+  it("errors when docs.json is missing", async () => {
+    const root = await createTempContentRoot({
+      "site.json": JSON.stringify({ name: "Old config" }, null, 2),
+    });
+
+    const result = await loadSiteConfig(createFsSource(root));
+
+    expect(result.ok).toBe(false);
+    if (result.ok) {
+      return;
+    }
+
+    expect(result.errors).toEqual(["docs.json not found."]);
+  });
+
+  it("loads the shipped tenant docs roots", async () => {
+    const exampleResult = await loadSiteConfig(
+      createFsSource(path.resolve(process.cwd(), "apps/docs/content/example"))
+    );
+    const blodeResult = await loadSiteConfig(
+      createFsSource(path.resolve(process.cwd(), "apps/docs/content/blode"))
+    );
+
+    expect(exampleResult.ok).toBe(true);
+    expect(blodeResult.ok).toBe(true);
+
+    if (!exampleResult.ok || !blodeResult.ok) {
+      return;
+    }
+
+    expect(exampleResult.config.collections[0]?.openapi).toEqual({
+      directory: "api",
+      source: "openapi.yaml",
+    });
+    expect(exampleResult.config.openapiProxy?.enabled).toBe(true);
+    expect(blodeResult.config.navigation?.groups).toMatchObject([
+      {
+        group: "Getting Started",
+        pages: ["index", "installation"],
+      },
+      {
+        group: "Customization",
+        pages: ["typography", "theming"],
+      },
+      {
+        group: "Components",
+        pages: ["components/breadcrumb"],
+      },
+    ]);
+    expect(blodeResult.config.navigation?.groups).toHaveLength(3);
+  });
+});
+
+describe("buildUtilityIndex", () => {
+  it("prebuilds content and OpenAPI utility pages", async () => {
+    const root = await createTempContentRoot({
+      "docs.json": JSON.stringify(
+        {
+          $schema: "https://mintlify.com/docs.json",
+          api: {
+            openapi: "openapi.yaml",
+          },
+          appearance: {
+            strict: true,
+          },
+          colors: {
+            primary: "#171717",
+          },
+          fonts: {
+            family: "Inter",
+          },
+          name: "Example Docs",
+          navbar: {
+            links: [{ href: "https://example.com", label: "Website" }],
+          },
+          navigation: {
+            groups: [{ group: "Docs", pages: ["index", "guide"] }],
+          },
+          theme: "mint",
+        },
+        null,
+        2
+      ),
+      "guide.mdx": "---\ntitle: Guide\n---\n# Guide\n\nShip it.\n",
+      "hidden.mdx": "---\ntitle: Hidden\nhidden: true\n---\n# Hidden\n",
+      "index.mdx": "---\ntitle: Welcome\n---\n# Welcome\n\nHello there.\n",
+      "openapi.yaml": [
+        "openapi: 3.0.0",
+        "paths:",
+        "  /projects:",
+        "    get:",
+        "      summary: List projects",
+        "      description: Return every project.",
+        "      tags:",
+        "        - Projects",
+        "      responses:",
+        "        '200':",
+        "          description: OK",
+      ].join("\n"),
+    });
+    const source = createFsSource(root);
+    const configResult = await loadSiteConfig(source);
+
+    expect(configResult.ok).toBe(true);
+    if (!configResult.ok) {
+      return;
+    }
+
+    const contentIndex = await buildContentIndex(source, configResult.config);
+    const utilityIndex = await buildUtilityIndex(
+      contentIndex,
+      source,
+      configResult.config
+    );
+
+    expect(utilityIndex.name).toBe("Example Docs");
+    expect(utilityIndex.pages.map((page) => page.slug)).toEqual([
+      "api/get-projects",
+      "guide",
+      "index",
+    ]);
+    expect(utilityIndex.pages.find((page) => page.slug === "hidden")).toBe(
+      undefined
+    );
+    expect(
+      utilityIndex.pages.find((page) => page.slug === "api/get-projects")
+        ?.content
+    ).toContain("Method: GET");
+
+    expect(
+      buildSearchIndex(contentIndex, configResult.config, utilityIndex)
+    ).toEqual(
+      expect.arrayContaining([
+        expect.objectContaining({
+          path: "api/get-projects",
+          title: "List projects",
+        }),
+      ])
+    );
+
+    const artifacts = buildUtilityArtifacts(utilityIndex);
+    expect(artifacts.map((artifact) => artifact.path)).toContain(
+      PREBUILT_UTILITY_SITEMAP_PATH
+    );
+    expect(artifacts.map((artifact) => artifact.path)).toContain(
+      PREBUILT_UTILITY_LLMS_PATH
+    );
+    expect(artifacts.map((artifact) => artifact.path)).toContain(
+      PREBUILT_UTILITY_LLMS_FULL_PATH
+    );
+    expect(artifacts.map((artifact) => artifact.path)).toContain(
+      getPrebuiltUtilityLlmPagePath("guide")
+    );
+    expect(
+      artifacts.find(
+        (artifact) => artifact.path === PREBUILT_UTILITY_SITEMAP_PATH
+      )?.content
+    ).toContain(`${UTILITY_DOCS_ROOT_TOKEN}/api/get-projects`);
+    expect(
+      artifacts.find(
+        (artifact) => artifact.path === PREBUILT_UTILITY_LLMS_FULL_PATH
+      )?.content
+    ).toContain("# Guide (__BLODEMD_DOCS_ROOT__/guide)\n\nShip it.");
+    expect(
+      artifacts.find(
+        (artifact) => artifact.path === getPrebuiltUtilityLlmPagePath("guide")
+      )?.content
+    ).toBe("# Guide\n\nShip it.");
+
+    await fs.writeFile(
+      path.join(root, PREBUILT_UTILITY_INDEX_PATH),
+      serializeUtilityIndex(utilityIndex)
+    );
+
+    await expect(loadPrebuiltUtilityIndex(source)).resolves.toEqual(
+      utilityIndex
+    );
+  });
+});

package/packages/@repo/validation/dist/index.d.ts

@@ -0,0 +1,12 @@
+import type { ContentType, FrontmatterByType, MintlifyDocsConfig, SiteConfig } from "@repo/models";
+export type ValidationResult<T> = {
+    success: true;
+    data: T;
+} | {
+    success: false;
+    errors: string[];
+};
+export declare const validateSiteConfig: (input: unknown) => ValidationResult<SiteConfig>;
+export declare const validateDocsConfig: (input: unknown) => ValidationResult<MintlifyDocsConfig>;
+export declare const validateFrontmatter: <Type extends ContentType>(type: Type, input: unknown) => ValidationResult<FrontmatterByType[Type]>;
+//# sourceMappingURL=index.d.ts.map

package/packages/@repo/validation/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EACV,WAAW,EACX,iBAAiB,EACjB,kBAAkB,EAClB,UAAU,EACX,MAAM,cAAc,CAAC;AAEtB,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAC1B;IAAE,OAAO,EAAE,IAAI,CAAC;IAAC,IAAI,EAAE,CAAC,CAAA;CAAE,GAC1B;IAAE,OAAO,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,MAAM,EAAE,CAAA;CAAE,CAAC;AAQzC,eAAO,MAAM,kBAAkB,GAC7B,OAAO,OAAO,KACb,gBAAgB,CAAC,UAAU,CAQ7B,CAAC;AAEF,eAAO,MAAM,kBAAkB,GAC7B,OAAO,OAAO,KACb,gBAAgB,CAAC,kBAAkB,CAQrC,CAAC;AAEF,eAAO,MAAM,mBAAmB,GAAI,IAAI,SAAS,WAAW,EAC1D,MAAM,IAAI,EACV,OAAO,OAAO,KACb,gBAAgB,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAS1C,CAAC"}

package/packages/@repo/validation/dist/index.js

@@ -0,0 +1,30 @@
+import { FrontmatterSchemaByType, MintlifyDocsConfigSchema, SiteConfigSchema, } from "@repo/models";
+const formatIssues = (issues) => issues.map((issue) => {
+    const path = issue.path.length ? issue.path.map(String).join(".") : "root";
+    return `${path}: ${issue.message}`;
+});
+export const validateSiteConfig = (input) => {
+    const result = SiteConfigSchema.safeParse(input);
+    if (result.success) {
+        return { data: result.data, success: true };
+    }
+    const issues = formatIssues(result.error.issues);
+    return { errors: issues, success: false };
+};
+export const validateDocsConfig = (input) => {
+    const result = MintlifyDocsConfigSchema.safeParse(input);
+    if (result.success) {
+        return { data: result.data, success: true };
+    }
+    const issues = formatIssues(result.error.issues);
+    return { errors: issues, success: false };
+};
+export const validateFrontmatter = (type, input) => {
+    const schema = FrontmatterSchemaByType[type];
+    const result = schema.safeParse(input);
+    if (result.success) {
+        return { data: result.data, success: true };
+    }
+    const issues = formatIssues(result.error.issues);
+    return { errors: issues, success: false };
+};

package/packages/@repo/validation/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@repo/validation",
+  "version": "0.0.0",
+  "private": true,
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./src/index.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./*": {
+      "types": "./src/*.ts",
+      "import": "./dist/*.js",
+      "default": "./dist/*.js"
+    }
+  },
+  "scripts": {
+    "build": "rm -rf dist && tsc",
+    "check-types": "tsc --noEmit",
+    "lint": "oxlint .",
+    "lint:fix": "oxlint --fix .",
+    "format": "oxfmt --write .",
+    "format:check": "oxfmt ."
+  },
+  "dependencies": {
+    "@repo/models": "*"
+  },
+  "devDependencies": {
+    "@repo/typescript-config": "*",
+    "@types/node": "^22.19.15",
+    "oxfmt": "^0.42.0",
+    "oxlint": "^1.57.0",
+    "typescript": "6.0.2",
+    "ultracite": "^7.3.2"
+  }
+}

package/packages/@repo/validation/src/index.ts

@@ -0,0 +1,59 @@
+import {
+  FrontmatterSchemaByType,
+  MintlifyDocsConfigSchema,
+  SiteConfigSchema,
+} from "@repo/models";
+import type {
+  ContentType,
+  FrontmatterByType,
+  MintlifyDocsConfig,
+  SiteConfig,
+} from "@repo/models";
+
+export type ValidationResult<T> =
+  | { success: true; data: T }
+  | { success: false; errors: string[] };
+
+const formatIssues = (issues: { path: PropertyKey[]; message: string }[]) =>
+  issues.map((issue) => {
+    const path = issue.path.length ? issue.path.map(String).join(".") : "root";
+    return `${path}: ${issue.message}`;
+  });
+
+export const validateSiteConfig = (
+  input: unknown
+): ValidationResult<SiteConfig> => {
+  const result = SiteConfigSchema.safeParse(input);
+  if (result.success) {
+    return { data: result.data, success: true };
+  }
+
+  const issues = formatIssues(result.error.issues);
+  return { errors: issues, success: false };
+};
+
+export const validateDocsConfig = (
+  input: unknown
+): ValidationResult<MintlifyDocsConfig> => {
+  const result = MintlifyDocsConfigSchema.safeParse(input);
+  if (result.success) {
+    return { data: result.data, success: true };
+  }
+
+  const issues = formatIssues(result.error.issues);
+  return { errors: issues, success: false };
+};
+
+export const validateFrontmatter = <Type extends ContentType>(
+  type: Type,
+  input: unknown
+): ValidationResult<FrontmatterByType[Type]> => {
+  const schema = FrontmatterSchemaByType[type];
+  const result = schema.safeParse(input);
+  if (result.success) {
+    return { data: result.data as FrontmatterByType[Type], success: true };
+  }
+
+  const issues = formatIssues(result.error.issues);
+  return { errors: issues, success: false };
+};