@seqera/docusaurus-theme-seqera 1.0.0 → 1.0.2-next.10

package/lib/translations.d.ts

@@ -0,0 +1,9 @@
+import type { TranslationFile } from '@docusaurus/types';
+import type { ThemeConfig } from '@docusaurus/theme-common';
+export declare function getTranslationFiles({ themeConfig, }: {
+    themeConfig: ThemeConfig;
+}): TranslationFile[];
+export declare function translateThemeConfig({ themeConfig, translationFiles, }: {
+    themeConfig: ThemeConfig;
+    translationFiles: TranslationFile[];
+}): ThemeConfig;

package/lib/translations.js

@@ -0,0 +1,172 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTranslationFiles = getTranslationFiles;
+exports.translateThemeConfig = translateThemeConfig;
+const tslib_1 = require("tslib");
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
+const utils_1 = require("@docusaurus/utils");
+function getNavbarTranslationFile(navbar) {
+    // TODO handle properly all the navbar item types here!
+    function flattenNavbarItems(items) {
+        const subItems = items.flatMap((item) => {
+            const allSubItems = [item.items ?? []].flat();
+            return flattenNavbarItems(allSubItems);
+        });
+        return [...items, ...subItems];
+    }
+    const allNavbarItems = flattenNavbarItems(navbar.items);
+    const navbarItemsTranslations = Object.fromEntries(allNavbarItems
+        .filter((navbarItem) => navbarItem.label)
+        .map((navbarItem) => [
+        `item.label.${navbarItem.label}`,
+        {
+            message: navbarItem.label,
+            description: `Navbar item with label ${navbarItem.label}`,
+        },
+    ]));
+    const titleTranslations = navbar.title
+        ? { title: { message: navbar.title, description: 'The title in the navbar' } }
+        : {};
+    const logoAlt = navbar.logo?.alt
+        ? {
+            'logo.alt': {
+                message: navbar.logo.alt,
+                description: 'The alt text of navbar logo',
+            },
+        }
+        : {};
+    return (0, utils_1.mergeTranslations)([
+        titleTranslations,
+        logoAlt,
+        navbarItemsTranslations,
+    ]);
+}
+function translateNavbar(navbar, navbarTranslations) {
+    if (!navbarTranslations) {
+        return navbar;
+    }
+    const logo = navbar.logo
+        ? {
+            ...navbar.logo,
+            alt: navbarTranslations[`logo.alt`]?.message ?? navbar.logo?.alt,
+        }
+        : undefined;
+    return {
+        ...navbar,
+        title: navbarTranslations.title?.message ?? navbar.title,
+        logo,
+        //  TODO handle properly all the navbar item types here!
+        items: navbar.items.map((item) => {
+            const subItems = item.items?.map((subItem) => ({
+                ...subItem,
+                label: navbarTranslations[`item.label.${subItem.label}`]?.message ??
+                    subItem.label,
+            }));
+            return {
+                ...item,
+                label: navbarTranslations[`item.label.${item.label}`]?.message ?? item.label,
+                ...(subItems ? { items: subItems } : undefined),
+            };
+        }),
+    };
+}
+function isMultiColumnFooterLinks(links) {
+    return links.length > 0 && 'title' in links[0];
+}
+function getFooterTranslationFile(footer) {
+    const footerLinkTitles = Object.fromEntries((isMultiColumnFooterLinks(footer.links)
+        ? footer.links.filter((link) => link.title)
+        : []).map((link) => [
+        `link.title.${link.title}`,
+        {
+            message: link.title,
+            description: `The title of the footer links column with title=${link.title} in the footer`,
+        },
+    ]));
+    const footerLinkLabels = Object.fromEntries((isMultiColumnFooterLinks(footer.links)
+        ? footer.links.flatMap((link) => link.items).filter((link) => link.label)
+        : footer.links.filter((link) => link.label)).map((link) => [
+        `link.item.label.${link.label}`,
+        {
+            message: link.label,
+            description: `The label of footer link with label=${link.label} linking to ${link.to ?? link.href}`,
+        },
+    ]));
+    const copyright = footer.copyright
+        ? {
+            copyright: {
+                message: footer.copyright,
+                description: 'The footer copyright',
+            },
+        }
+        : {};
+    const logoAlt = footer.logo?.alt
+        ? {
+            'logo.alt': {
+                message: footer.logo.alt,
+                description: 'The alt text of footer logo',
+            },
+        }
+        : {};
+    return (0, utils_1.mergeTranslations)([
+        footerLinkTitles,
+        footerLinkLabels,
+        copyright,
+        logoAlt,
+    ]);
+}
+function translateFooter(footer, footerTranslations) {
+    if (!footerTranslations) {
+        return footer;
+    }
+    const links = isMultiColumnFooterLinks(footer.links)
+        ? footer.links.map((link) => ({
+            ...link,
+            title: footerTranslations[`link.title.${link.title}`]?.message ?? link.title,
+            items: link.items.map((linkItem) => ({
+                ...linkItem,
+                label: footerTranslations[`link.item.label.${linkItem.label}`]?.message ??
+                    linkItem.label,
+            })),
+        }))
+        : footer.links.map((link) => ({
+            ...link,
+            label: footerTranslations[`link.item.label.${link.label}`]?.message ??
+                link.label,
+        }));
+    const copyright = footerTranslations.copyright?.message ?? footer.copyright;
+    const logo = footer.logo
+        ? {
+            ...footer.logo,
+            alt: footerTranslations[`logo.alt`]?.message ?? footer.logo?.alt,
+        }
+        : undefined;
+    return {
+        ...footer,
+        links,
+        copyright,
+        logo,
+    };
+}
+function getTranslationFiles({ themeConfig, }) {
+    const translationFiles = [
+        { path: 'navbar', content: getNavbarTranslationFile(themeConfig.navbar) },
+        themeConfig.footer
+            ? {
+                path: 'footer',
+                content: getFooterTranslationFile(themeConfig.footer),
+            }
+            : undefined,
+    ];
+    return translationFiles.filter(Boolean);
+}
+function translateThemeConfig({ themeConfig, translationFiles, }) {
+    const translationFilesMap = lodash_1.default.keyBy(translationFiles, (f) => f.path);
+    return {
+        ...themeConfig,
+        navbar: translateNavbar(themeConfig.navbar, translationFilesMap.navbar?.content),
+        footer: themeConfig.footer
+            ? translateFooter(themeConfig.footer, translationFilesMap.footer?.content)
+            : undefined,
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seqera/docusaurus-theme-seqera",
-  "version": "1.0.0",
+  "version": "1.0.2-next.10",
   "description": "Seqera docs theme for Docusaurus",
   "author": "Seqera docs team <education@seqera.io>",
   "license": "Apache-2.0",
@@ -10,10 +10,10 @@
     "access": "public"
   },
   "scripts": {
-    "build": "tsc --build && node ../../admin/scripts/copyUntypedFiles.js && prettier --config ../../.prettierrc --write \"lib/theme/**/*.js\"",
+    "build": "tsc --build && node ../../scripts/copyUntypedFiles.js && prettier --config ../../.prettierrc --write \"lib/theme/**/*.js\"",
     "watch": "run-p -c copy:watch build:watch",
     "build:watch": "tsc --build --watch",
-    "copy:watch": "node ../../admin/scripts/copyUntypedFiles.js --watch"
+    "copy:watch": "node ../../scripts/copyUntypedFiles.js --watch"
   },
   "dependencies": {
     "@docusaurus/core": "3.9.2",
@@ -48,6 +48,7 @@
   },
   "devDependencies": {
     "@tailwindcss/typography": "^0.5.19",
+    "@types/lodash": "^4.17.0",
     "@types/nprogress": "^0.2.0",
     "@types/prismjs": "^1.26.0",
     "@types/rtlcss": "^3.5.1",

package/src/index.ts

@@ -13,7 +13,7 @@ import type {Plugin as PostCssPlugin} from 'postcss';
 import type {
   PluginOptions,
   ThemeConfig,
-} from "@seqeralabs/docusaurus-theme-seqera";
+} from "@seqera/docusaurus-theme-seqera";
 import postcssImport from "postcss-import";
 
 function getInfimaCSSFile(direction: string) {
@@ -102,7 +102,7 @@ export default function themeSeqera(
           rules: [
             {
               resourceQuery: /raw/,
-              type: 'asset/source', 
+              type: 'asset/source',
             },
           ],
         },
@@ -151,4 +151,4 @@ ${announcementBar ? getAnnouncementBarInlineScript({siteStorage}) : ''}
 }
 
 export {default as getSwizzleConfig} from './getSwizzleConfig';
-export {validateThemeConfig, validateOptions} from './options';
+export {validateThemeConfig, validateOptions} from './options';

package/src/options.ts

@@ -6,7 +6,7 @@ import type {
   PropVersionItem,
   PropVersionItems,
 } from '@theme/NavbarItem/DocsVersionDropdownNavbarItem';
-import type {Options, PluginOptions} from '@seqeralabs/docusaurus-theme-seqera';
+import type {Options, PluginOptions} from '@seqera/docusaurus-theme-seqera';
 import type {ThemeConfig} from '@docusaurus/theme-common';
 import type {
   ThemeConfigValidationContext,

package/src/theme-seqera.d.ts

@@ -13,7 +13,7 @@
 // our theme shadowing—we probably need the user to specify multiple theme paths
 // in their tsconfig.
 
-declare module '@seqeralabs/docusaurus-theme-seqera' {
+declare module '@seqera/docusaurus-theme-seqera' {
   import type {LoadContext, Plugin, PluginModule} from '@docusaurus/types';
   import type {ThemeConfig as DefaultThemeConfig} from '@docusaurus/theme-common';
   import type {Config as tailwindConfig} from 'tailwindcss';
@@ -1096,7 +1096,7 @@ declare module '@theme/MDXComponents/A' {
 declare module '@theme/MDXComponents/Button' {
   import type { ComponentProps } from 'react';
   import type OriginalMDXComponents from '@theme-original/MDXComponents';
-  
+
   export interface MDXComponentsObject {
     Button: React.ComponentType<{
       children: React.ReactNode;