twenty/packages/twenty-docs/scripts/generate-docs-json.ts

import fs from 'fs';
import path from 'path';

import {
  DEFAULT_LANGUAGE,
  SUPPORTED_LANGUAGES,
} from '../navigation/supported-languages';

type BasePage = string | BaseGroup;

type BaseGroup = {
  key: string;
  label: string;
  icon?: string;
  pages: BasePage[];
};

type BaseTab = {
  key: string;
  label: string;
  groups: BaseGroup[];
};

type BaseStructure = {
  tabs: BaseTab[];
};

type TranslationGroupEntry = {
  label: string;
  groups?: Record<string, TranslationGroupEntry>;
};

type TranslationTabEntry = {
  label: string;
  groups: Record<string, TranslationGroupEntry>;
};

type TranslationFile = {
  tabs: Record<string, TranslationTabEntry>;
};

type TranslationMaps = {
  tabLabels: Map<string, string>;
  groupLabels: Map<string, string>;
};

type GeneratedLanguage = {
  language: string;
  tabs: Array<{
    tab: string;
    groups: GeneratedGroup[];
  }>;
};

type GeneratedGroup = {
  group: string;
  icon?: string;
  pages: Array<string | GeneratedGroup>;
};

const baseStructurePath = path.resolve(
  __dirname,
  '../navigation/base-structure.json',
);
const docsPath = path.resolve(__dirname, '../docs.json');
const localesRoot = path.resolve(__dirname, '../l');

const baseStructure: BaseStructure = JSON.parse(
  fs.readFileSync(baseStructurePath, 'utf8'),
);

const docsConfig = JSON.parse(fs.readFileSync(docsPath, 'utf8'));

const collectTranslations = (file: TranslationFile | null): TranslationMaps => {
  const tabLabels = new Map<string, string>();
  const groupLabels = new Map<string, string>();

  const collectGroups = (groups?: Record<string, TranslationGroupEntry>) => {
    if (!groups) {
      return;
    }

    Object.entries(groups).forEach(([key, group]) => {
      groupLabels.set(key, group.label);
      collectGroups(group.groups);
    });
  };

  Object.entries(file?.tabs ?? {}).forEach(([key, tab]) => {
    tabLabels.set(key, tab.label);
    collectGroups(tab.groups);
  });

  return { tabLabels, groupLabels };
};

const loadTranslationFile = (language: string): TranslationFile | null => {
  const translationPath = path.join(localesRoot, language, 'navigation.json');

  if (!fs.existsSync(translationPath)) {
    return null;
  }

  return JSON.parse(
    fs.readFileSync(translationPath, 'utf8'),
  ) as TranslationFile;
};

const buildLanguageEntry = (language: string): GeneratedLanguage => {
  const translationFile =
    language === DEFAULT_LANGUAGE ? null : loadTranslationFile(language);
  const translationMaps = collectTranslations(translationFile);

  return {
    language,
    tabs: baseStructure.tabs
      .map((tab) => ({
        tab: translationMaps.tabLabels.get(tab.key) ?? tab.label,
        groups: tab.groups
          .map((group) => buildGroup(group, translationMaps, language))
          .filter((group): group is GeneratedGroup => group !== null),
      }))
      .filter((tab) => tab.groups.length > 0),
  };
};

// Mintlify requires each page path to appear in only one language's navigation.
// Duplicating a path across languages breaks the language switcher (it can no
// longer resolve the equivalent page and falls back to the first page). So a
// page is only included in a non-default language when its translation exists,
// and empty groups/tabs are dropped entirely.
const buildGroup = (
  group: BaseGroup,
  translations: TranslationMaps,
  language: string,
): GeneratedGroup | null => {
  const pages = group.pages
    .map((page) =>
      typeof page === 'string'
        ? formatPageSlug(page, language)
        : buildGroup(page, translations, language),
    )
    .filter((page): page is string | GeneratedGroup => page !== null);

  if (pages.length === 0) {
    return null;
  }

  return {
    group: translations.groupLabels.get(group.key) ?? group.label,
    ...(group.icon ? { icon: group.icon } : {}),
    pages,
  };
};

const formatPageSlug = (slug: string, language: string): string | null => {
  if (language === DEFAULT_LANGUAGE) {
    return slug;
  }

  const localizedPagePath = path.join(localesRoot, language, `${slug}.mdx`);

  return fs.existsSync(localizedPagePath) ? `l/${language}/${slug}` : null;
};

const hasLocaleContent = (language: string): boolean => {
  if (language === DEFAULT_LANGUAGE) {
    return true;
  }

  const localeDir = path.join(localesRoot, language);
  return fs.existsSync(localeDir);
};

const languages =
  SUPPORTED_LANGUAGES.filter(hasLocaleContent).map(buildLanguageEntry);

if (!docsConfig.navigation) {
  docsConfig.navigation = {};
}

docsConfig.navigation.languages = languages;

fs.writeFileSync(docsPath, `${JSON.stringify(docsConfig, null, 2)}\n`);