@supatent/supatent-docs 0.1.0

package/runtime/src/framework/settings.ts

@@ -0,0 +1,43 @@
+import type { DocsSettings } from "./types";
+
+const siteTitlePaths = [
+  "siteTitle",
+  "site-title",
+  "site_title",
+  "title",
+  "name",
+  "site.title",
+  "site.name",
+] as const;
+
+function readValueAtPath(input: unknown, path: string): unknown {
+  const keys = path.split(".");
+  let current: unknown = input;
+
+  for (const key of keys) {
+    if (!current || typeof current !== "object") {
+      return null;
+    }
+
+    current = (current as Record<string, unknown>)[key];
+  }
+
+  return current;
+}
+
+export function resolveSiteTitleFromSettings(
+  settings: DocsSettings | null,
+): string | null {
+  if (!settings) {
+    return null;
+  }
+
+  for (const path of siteTitlePaths) {
+    const value = readValueAtPath(settings, path);
+    if (typeof value === "string" && value.trim()) {
+      return value.trim();
+    }
+  }
+
+  return null;
+}

package/runtime/src/framework/site-title.ts

@@ -0,0 +1,54 @@
+import { cache } from "react";
+import { docsConfig } from "../docs.config";
+import { resolveLocaleCandidates } from "./locales";
+import { createSupatentDocsRepository } from "./repository";
+import { getRuntimeLocales } from "./runtime-locales";
+import { resolveSiteTitleFromSettings } from "./settings";
+
+const getConfiguredSiteTitle = cache(async (requestedLocale: string): Promise<string | null> => {
+  const runtimeLocales = await getRuntimeLocales({
+    dataMode: docsConfig.supatent.dataMode,
+  });
+  const repository = createSupatentDocsRepository(docsConfig, {
+    dataMode: docsConfig.supatent.dataMode,
+  });
+  const localeConfig = {
+    defaultLocale: runtimeLocales.defaultLocale,
+    locales: runtimeLocales.locales,
+    fallbackMode: docsConfig.routing.fallbackMode,
+  };
+  const candidates = requestedLocale
+    ? resolveLocaleCandidates(requestedLocale, localeConfig)
+    : [localeConfig.defaultLocale];
+
+  let lastError: unknown = null;
+
+  for (const locale of candidates) {
+    try {
+      const settings = await repository.getSettings(locale);
+      const siteTitle = resolveSiteTitleFromSettings(settings);
+      if (siteTitle) {
+        return siteTitle;
+      }
+    } catch (error) {
+      lastError = error;
+    }
+  }
+
+  if (lastError) {
+    const reason = lastError instanceof Error
+      ? lastError.message
+      : "Unknown settings fetch failure";
+    console.warn(
+      `[supatent-docs] Settings fetch failed (${reason}). No site title resolved.`,
+    );
+  }
+
+  return null;
+});
+
+export async function getSiteTitle(
+  requestedLocale?: string | null,
+): Promise<string | null> {
+  return getConfiguredSiteTitle(requestedLocale?.trim() || "");
+}

package/runtime/src/framework/theme.ts

@@ -0,0 +1,17 @@
+export const docsThemeTokens = {
+  background: "#fcf9f2",
+  foreground: "#1f1f1a",
+  mutedForeground: "#5a5a4e",
+  border: "#dad4c5",
+  accent: "#004e64",
+  accentForeground: "#f4f9fb",
+  navBackground: "#f4efe2",
+  codeBackground: "#ece6d7",
+  maxWidth: "1100px",
+  navWidth: "290px",
+  radius: "10px",
+  fontBody: "'IBM Plex Sans', system-ui, sans-serif",
+  fontHeading: "'Fraunces', Georgia, serif",
+  fontMono: "'IBM Plex Mono', ui-monospace, monospace",
+} as const;
+

package/runtime/src/framework/types.ts

@@ -0,0 +1,66 @@
+export type LocaleFallbackMode = "none" | "defaultLocale";
+export type DocsDataMode = "published" | "draft";
+
+export type DocsFrameworkConfig = {
+  supatent: {
+    baseUrl: string;
+    apiKey?: string;
+    dataMode: DocsDataMode;
+    projectSlug: string;
+    cache: {
+      maxAge: number;
+      staleWhileRevalidate: number;
+    };
+  };
+  schemas: {
+    settings: string;
+    page: string;
+    category: string;
+  };
+  routing: {
+    basePath: string;
+    defaultLocale: string;
+    locales: string[];
+    fallbackMode: LocaleFallbackMode;
+  };
+};
+
+export type DocsPage = {
+  slug: string;
+  title: string;
+  body: string;
+  category: string;
+  order: number;
+  locale: string;
+};
+
+export type DocsSettings = Record<string, unknown>;
+
+export type DocsCategory = {
+  slug: string;
+  title: string;
+  order: number;
+  locale: string;
+};
+
+export type DocsNavNode = {
+  id: string;
+  title: string;
+  slug: string | null;
+  path: string | null;
+  order: number;
+  children: DocsNavNode[];
+};
+
+export type DocsPageResolution = {
+  page: DocsPage;
+  requestedLocale: string;
+  resolvedLocale: string;
+  usedFallback: boolean;
+};
+
+export type DocsLocaleRuntimeConfig = {
+  defaultLocale: string;
+  locales: string[];
+  fallbackMode: LocaleFallbackMode;
+};

package/runtime/src/framework/url.ts

@@ -0,0 +1,78 @@
+import type { DocsFrameworkConfig } from "./types";
+
+export const INTERNAL_DOCS_SEGMENT = "docs-internal";
+
+function trimSlashes(value: string): string {
+  return value.replace(/^\/+|\/+$/g, "");
+}
+
+function joinSegments(...segments: Array<string | undefined>): string {
+  const cleaned = segments
+    .filter((segment): segment is string => Boolean(segment))
+    .map(trimSlashes)
+    .filter(Boolean);
+
+  return `/${cleaned.join("/")}`;
+}
+
+export function normalizeSlug(slugSegments?: string[]): string {
+  if (!slugSegments || slugSegments.length === 0) {
+    return "";
+  }
+
+  return slugSegments.map(trimSlashes).filter(Boolean).join("/");
+}
+
+export function toDocsPagePath(
+  config: DocsFrameworkConfig,
+  locale: string,
+  slug = "",
+): string {
+  return joinSegments(locale, config.routing.basePath, slug);
+}
+
+export function toDocsMarkdownPath(
+  config: DocsFrameworkConfig,
+  locale: string,
+  slug: string,
+): string {
+  return joinSegments(locale, config.routing.basePath, slug, "markdown");
+}
+
+export function toDocsAiIndexPath(
+  config: DocsFrameworkConfig,
+  locale: string,
+): string {
+  return joinSegments(locale, config.routing.basePath, "ai", "index");
+}
+
+export function toDocsAiAllPath(config: DocsFrameworkConfig, locale: string): string {
+  return joinSegments(locale, config.routing.basePath, "ai", "all");
+}
+
+export function toInternalDocsPath(pathname: string, config: DocsFrameworkConfig): string | null {
+  const segments = pathname.split("/").filter(Boolean);
+  if (segments.length < 2) {
+    return null;
+  }
+
+  const [locale, ...rest] = segments;
+
+  const basePathSegments = config.routing.basePath.split("/").filter(Boolean);
+  const pathMatchesBase =
+    rest.length >= basePathSegments.length &&
+    basePathSegments.every((segment, index) => rest[index] === segment);
+
+  if (!pathMatchesBase) {
+    return null;
+  }
+
+  const tail = rest.slice(basePathSegments.length);
+
+  if (tail.length >= 2 && tail[tail.length - 1] === "markdown") {
+    const slug = tail.slice(0, -1).join("/");
+    return joinSegments(locale, INTERNAL_DOCS_SEGMENT, "markdown", slug);
+  }
+
+  return joinSegments(locale, INTERNAL_DOCS_SEGMENT, tail.join("/"));
+}

package/runtime/src/supatent/client.ts

@@ -0,0 +1,2 @@
+export * from "@supatent/client";
+

package/src/index.ts

@@ -0,0 +1,11 @@
+export { defineDocsConfig } from "../runtime/src/framework/config";
+export type {
+  DocsCategory,
+  DocsDataMode,
+  DocsFrameworkConfig,
+  DocsLocaleRuntimeConfig,
+  DocsNavNode,
+  DocsPage,
+  DocsPageResolution,
+  LocaleFallbackMode,
+} from "../runtime/src/framework/types";

package/src/next-config.ts

@@ -0,0 +1,5 @@
+export {
+  withSupatentDocs,
+  type SupatentDocsNextConfigOptions,
+  type SupatentDocsSearchIndexOptions,
+} from "../runtime/src/framework/next-config";

package/src/next.ts

@@ -0,0 +1,10 @@
+export { metadata as docsMetadata } from "../runtime/src/app/layout";
+export { default as DocsRootLayout } from "../runtime/src/app/layout";
+export { default as DocsHomePage } from "../runtime/src/app/page";
+
+export { default as DocsInternalPage } from "../runtime/src/app/[locale]/docs-internal/[[...slug]]/page";
+export { GET as getDocsAiIndex } from "../runtime/src/app/[locale]/docs-internal/ai/index/route";
+export { GET as getDocsAiAll } from "../runtime/src/app/[locale]/docs-internal/ai/all/route";
+export { GET as getDocsMarkdownPage } from "../runtime/src/app/[locale]/docs-internal/markdown/[...slug]/route";
+
+export { middleware as docsMiddleware } from "../runtime/middleware";