@hagicode/hagilight-docusaurus 0.0.0-stage → 0.1.0-dev.148.1.e0c630e

package/dist/seo.d.ts

@@ -0,0 +1,14 @@
+import type { HtmlTagObject } from '@docusaurus/types';
+import type { ResolvedSeoOptions } from './options.js';
+export interface SeoSite {
+    title: string;
+    url: string;
+    baseUrl: string;
+}
+export declare function resolveSharingImage(image: string | undefined, site: Pick<SeoSite, 'url' | 'baseUrl'>): string | undefined;
+export interface SharingMetadataValues {
+    siteName: string;
+    image: string | undefined;
+}
+export declare function sharingMetadataFor(seo: ResolvedSeoOptions, site: Pick<SeoSite, 'title' | 'url' | 'baseUrl'>, themeImage: string | undefined): SharingMetadataValues | undefined;
+export declare function seoHeadTags(seo: ResolvedSeoOptions, site: SeoSite): HtmlTagObject[];

package/dist/seo.js

@@ -0,0 +1,32 @@
+import { buildOrganizationStructuredData, resolveSeoImageUrl, serializeJsonLd } from '@hagicode/hagilight-core/seo';
+export function resolveSharingImage(image, site) {
+    return image === undefined ? undefined : resolveSeoImageUrl(image, { site: site.url, basePath: site.baseUrl });
+}
+export function sharingMetadataFor(seo, site, themeImage) {
+    if (!seo.enabled)
+        return undefined;
+    return {
+        siteName: site.title,
+        image: themeImage === undefined ? resolveSharingImage(seo.image, site) : undefined,
+    };
+}
+export function seoHeadTags(seo, site) {
+    if (!seo.enabled)
+        return [];
+    const organization = buildOrganizationStructuredData({
+        name: seo.organization.name ?? site.title,
+        url: seo.organization.url ?? site.url,
+        ...(seo.organization.logo === undefined ? {} : { logo: seo.organization.logo }),
+    });
+    const website = {
+        '@context': 'https://schema.org',
+        '@type': 'WebSite',
+        name: site.title,
+        url: new URL(site.baseUrl, site.url).href,
+    };
+    return [organization, website].map((data) => ({
+        tagName: 'script',
+        attributes: { type: 'application/ld+json' },
+        innerHTML: serializeJsonLd(data),
+    }));
+}

package/dist/theme/Footer/FooterView.d.ts

@@ -0,0 +1,17 @@
+import { type ReactElement } from 'react';
+import { type BuildInfo } from '@hagicode/hagilight-core/build-info';
+import type { FooterLinks } from '../../footer.js';
+/** The decorative avatar: the vendored default pair and, when the random option is on, the baked pool. */
+export interface FooterAvatar {
+    avif: string;
+    webp: string;
+    randomPool?: readonly string[];
+}
+export interface FooterViewProps {
+    links: FooterLinks;
+    version: string;
+    year: number;
+    buildInfo?: BuildInfo;
+    avatar?: FooterAvatar;
+}
+export declare function FooterView({ links, version, year, buildInfo, avatar }: FooterViewProps): ReactElement;

package/dist/theme/Footer/FooterView.js

@@ -0,0 +1,20 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { Fragment } from 'react';
+import { siteLinkGaAttributes } from '@hagicode/hagilight-core/analytics-events';
+import { buildInfoItems } from '@hagicode/hagilight-core/build-info';
+import { pickFooterBrandLinks, resolveFooterBrand } from '@hagicode/hagilight-core/footer-brand';
+import { footerAvatarImageAttributes } from '@hagicode/hagilight-core/footer-avatar';
+import { randomPoolAttribute } from '@hagicode/hagilight-core/random-image';
+function LinkSection({ heading, navLabel, links, tagged }) {
+    return (_jsxs("section", { children: [_jsx("h2", { children: heading }), _jsx("nav", { "aria-label": navLabel, children: _jsx("ul", { children: links.map((link) => (_jsx("li", { children: _jsx("a", { href: link.href, target: link.target, rel: link.rel, "aria-label": link.ariaLabel, ...(tagged ? siteLinkGaAttributes(link, 'footer') : {}), children: link.label }) }, link.id))) }) })] }));
+}
+function FooterBrand({ locale, links, avatar }) {
+    const brand = resolveFooterBrand(locale);
+    const { primary, secondary } = pickFooterBrandLinks(links);
+    return (_jsxs("section", { className: "hagilight-brand", lang: brand.locale, "aria-labelledby": "hagilight-brand-title", children: [_jsxs("div", { className: "hagilight-brand__lead", children: [_jsxs("div", { className: "hagilight-brand__title", children: [avatar && (_jsxs("picture", { className: "hagilight-brand__avatar", "data-random-pool": avatar.randomPool && randomPoolAttribute(avatar.randomPool), children: [_jsx("source", { type: "image/avif", srcSet: avatar.avif }), _jsx("source", { type: "image/webp", srcSet: avatar.webp }), _jsx("img", { src: avatar.webp, ...footerAvatarImageAttributes() })] })), _jsx("h2", { className: "hagilight-brand__headline", id: "hagilight-brand-title", children: brand.headline })] }), _jsxs("div", { className: "hagilight-brand__body", children: [_jsx("p", { className: "hagilight-brand__summary", children: brand.summary }), (primary || secondary) && (_jsxs("div", { className: "hagilight-brand__actions", children: [primary && (_jsxs("a", { className: "hagilight-brand__primary", href: primary.href, target: primary.target, rel: primary.rel, "aria-label": primary.ariaLabel, ...siteLinkGaAttributes(primary, 'footer_brand'), children: [_jsx("span", { children: primary.label }), _jsx("svg", { className: "hagilight-brand__arrow", viewBox: "0 0 16 16", width: "16", height: "16", "aria-hidden": "true", focusable: "false", children: _jsx("path", { d: "M2.5 8h10M8.5 3.5 13 8l-4.5 4.5", fill: "none", stroke: "currentColor", strokeWidth: "1.75", strokeLinecap: "round", strokeLinejoin: "round" }) })] })), secondary && (_jsx("a", { className: "hagilight-brand__secondary", href: secondary.href, target: secondary.target, rel: secondary.rel, "aria-label": secondary.ariaLabel, ...siteLinkGaAttributes(secondary, 'footer_brand'), children: secondary.label }))] }))] })] }), _jsx("dl", { className: "hagilight-brand__pillars", children: brand.pillars.map((pillar, index) => (_jsxs("div", { className: "hagilight-brand__pillar", "data-pillar": pillar.id, style: { '--hagilight-brand-i': index }, children: [_jsx("dt", { children: pillar.label }), _jsx("dd", { children: pillar.description })] }, pillar.id))) })] }));
+}
+export function FooterView({ links, version, year, buildInfo, avatar }) {
+    const { labels } = links;
+    const buildItems = buildInfoItems(buildInfo);
+    return (_jsxs("footer", { className: "hagilight-footer", children: [_jsx(FooterBrand, { locale: links.locale, links: links.quick, avatar: avatar }), _jsxs("div", { className: "hagilight-footer__sections", children: [links.relatedSites.length > 0 && (_jsxs("section", { children: [_jsx("h2", { children: labels.relatedSites }), _jsx("nav", { "aria-label": labels.navigation.relatedSites, children: _jsx("ul", { children: links.relatedSites.map((site) => (_jsx("li", { children: _jsx("a", { href: site.href, target: site.target, rel: site.rel, children: site.name }) }, site.id))) }) })] })), _jsx(LinkSection, { heading: labels.quickLinks, navLabel: labels.navigation.quickLinks, links: links.quick, tagged: true }), _jsx(LinkSection, { heading: labels.community, navLabel: labels.navigation.community, links: links.community, tagged: true })] }), links.filings.length > 0 && (_jsx("nav", { className: "hagilight-footer__filings", "aria-label": labels.navigation.filings, children: links.filings.map((link) => (_jsx("a", { href: link.href, target: link.target, rel: link.rel, "aria-label": link.ariaLabel, children: link.label }, link.id))) })), _jsxs("p", { className: "hagilight-footer__copyright", children: [_jsxs("span", { children: ["\u00A9 ", year, " HagiCode"] }), ' | ', _jsxs("span", { className: "hagilight-footer__attribution", children: ["Powered By hagilight-docusaurus@", version] }), buildItems.map((item) => (_jsxs(Fragment, { children: [' | ', _jsxs("span", { className: "hagilight-footer__build", "data-build-field": item.field, title: item.title, "data-build-commit": item.title, children: [item.label, ": ", item.datetime ? _jsx("time", { dateTime: item.datetime, children: item.text }) : item.text] })] }, item.field)))] })] }));
+}

package/dist/theme/Footer/index.d.ts

@@ -0,0 +1,2 @@
+import type { ReactElement } from 'react';
+export default function Footer(): ReactElement;

package/dist/theme/Footer/index.js

@@ -0,0 +1,25 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import FooterDefaults from '@theme-init/Footer';
+import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
+import { usePluginData } from '@docusaurus/useGlobalData';
+import { resolveFooterLinks } from '../../footer.js';
+import { PLUGIN_NAME } from '../../global-data.js';
+import { FooterView } from './FooterView.js';
+import avatarAvif from '@hagicode/hagilight-core/assets/footer/avatar.avif';
+import avatarWebp from '@hagicode/hagilight-core/assets/footer/avatar.webp';
+export default function Footer() {
+    const { i18n, siteConfig } = useDocusaurusContext();
+    const { version, options, buildInfo, footerAvatarPool } = usePluginData(PLUGIN_NAME);
+    if (!options.footer)
+        return _jsx(FooterDefaults, {});
+    const avatar = options.footerAvatar.avatar
+        ? { avif: avatarAvif, webp: avatarWebp, randomPool: footerAvatarPool }
+        : undefined;
+    const links = resolveFooterLinks({
+        locale: i18n.currentLocale,
+        baseUrl: siteConfig.baseUrl,
+        links: options.links,
+        rssEnabled: options.rss.enabled,
+    });
+    return (_jsx(FooterView, { links: links, version: version, year: new Date().getFullYear(), buildInfo: buildInfo, avatar: avatar }));
+}

package/dist/theme/SiteMetadata/SharingMetadata.d.ts

@@ -0,0 +1,8 @@
+import type { Props as HeadProps } from '@docusaurus/Head';
+import type { ReactElement, ReactNode } from 'react';
+export interface SharingMetadataProps {
+    Head: (props: HeadProps) => ReactNode;
+    siteName: string;
+    image: string | undefined;
+}
+export declare function SharingMetadata({ Head, siteName, image }: SharingMetadataProps): ReactElement;

package/dist/theme/SiteMetadata/SharingMetadata.js

@@ -0,0 +1,4 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+export function SharingMetadata({ Head, siteName, image }) {
+    return (_jsxs(Head, { children: [_jsx("meta", { property: "og:site_name", content: siteName }), image !== undefined && _jsx("meta", { property: "og:image", content: image }), image !== undefined && _jsx("meta", { name: "twitter:image", content: image })] }));
+}

package/dist/theme/SiteMetadata/index.d.ts

@@ -0,0 +1,2 @@
+import type { ReactElement } from 'react';
+export default function SiteMetadata(): ReactElement;

package/dist/theme/SiteMetadata/index.js

@@ -0,0 +1,15 @@
+import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
+import Head from '@docusaurus/Head';
+import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
+import { usePluginData } from '@docusaurus/useGlobalData';
+import ClassicSiteMetadata from '@docusaurus/theme-classic/lib/theme/SiteMetadata/index.js';
+import { PLUGIN_NAME } from '../../global-data.js';
+import { sharingMetadataFor } from '../../seo.js';
+import { SharingMetadata } from './SharingMetadata.js';
+export default function SiteMetadata() {
+    const { siteConfig } = useDocusaurusContext();
+    const { options } = usePluginData(PLUGIN_NAME);
+    const themeImage = siteConfig.themeConfig?.image;
+    const sharing = sharingMetadataFor(options.seo, siteConfig, typeof themeImage === 'string' ? themeImage : undefined);
+    return (_jsxs(_Fragment, { children: [sharing !== undefined && _jsx(SharingMetadata, { Head: Head, ...sharing }), _jsx(ClassicSiteMetadata, {})] }));
+}

package/dist/warnings.d.ts

@@ -0,0 +1,4 @@
+import type { LoadContext } from '@docusaurus/types';
+import type { ResolvedHagilightOptions } from './options.js';
+export declare function siteOwnsThemeComponent(siteDir: string, name: string): boolean;
+export declare function findConfigurationWarnings(context: Pick<LoadContext, 'siteDir' | 'siteConfig' | 'i18n'>, options: ResolvedHagilightOptions): string[];

package/dist/warnings.js

@@ -0,0 +1,70 @@
+import { existsSync } from 'node:fs';
+import { join } from 'node:path';
+import { locales as catalogLocales } from './locales.js';
+const THEME_EXTENSIONS = ['tsx', 'ts', 'jsx', 'js'];
+const GTAG_PLUGIN = '@docusaurus/plugin-google-gtag';
+const CLASSIC_PRESET = '@docusaurus/preset-classic';
+const CATALOG_LOCALES = new Set(catalogLocales);
+export function siteOwnsThemeComponent(siteDir, name) {
+    const themeDir = join(siteDir, 'src', 'theme');
+    return THEME_EXTENSIONS.some((ext) => existsSync(join(themeDir, name, `index.${ext}`)) || existsSync(join(themeDir, `${name}.${ext}`)));
+}
+function entryName(entry) {
+    if (typeof entry === 'string')
+        return entry;
+    if (Array.isArray(entry) && typeof entry[0] === 'string')
+        return entry[0];
+    return undefined;
+}
+function entryOptions(entry) {
+    if (!Array.isArray(entry))
+        return undefined;
+    const options = entry[1];
+    return typeof options === 'object' && options !== null ? options : undefined;
+}
+function hasPluginEntry(entries, name) {
+    return Array.isArray(entries) && entries.some((entry) => entryName(entry) === name);
+}
+function hasLocaleDropdown(themeConfig) {
+    const navbar = themeConfig.navbar;
+    if (typeof navbar !== 'object' || navbar === null)
+        return false;
+    const items = navbar.items;
+    return Array.isArray(items) && items.some((item) => item?.type === 'localeDropdown');
+}
+function officialGtagConfigured(siteConfig) {
+    const raw = siteConfig;
+    if (hasPluginEntry(raw.plugins, GTAG_PLUGIN))
+        return true;
+    return Array.isArray(raw.presets)
+        && raw.presets.some((preset) => entryName(preset) === CLASSIC_PRESET && entryOptions(preset)?.gtag !== undefined);
+}
+export function findConfigurationWarnings(context, options) {
+    const warnings = [];
+    const themeConfig = (context.siteConfig.themeConfig ?? {});
+    if (options.languageSelector && context.i18n.locales.length > 1) {
+        if (!hasLocaleDropdown(themeConfig)) {
+            warnings.push("Several locales are configured but themeConfig.navbar.items has no localeDropdown item, so visitors cannot switch language. Add { type: 'localeDropdown' } or set languageSelector: { enabled: false }.");
+        }
+        const nonCatalog = context.i18n.locales.filter((locale) => !CATALOG_LOCALES.has(locale));
+        if (nonCatalog.length > 0) {
+            warnings.push(`${nonCatalog.join(', ')} ${nonCatalog.length === 1 ? 'is' : 'are'} not in the Hagilight locale catalog, so its native label and lang value are not checked against the Starlight locales. Use catalog locales or set languageSelector: { enabled: false }.`);
+        }
+    }
+    if (options.footer && siteOwnsThemeComponent(context.siteDir, 'Footer')) {
+        warnings.push('src/theme/Footer replaces the Hagilight footer. Remove the site Footer component or set footer: { enabled: false } to keep one footer.');
+    }
+    if (options.seo.enabled && siteOwnsThemeComponent(context.siteDir, 'SiteMetadata')) {
+        warnings.push('src/theme/SiteMetadata replaces the Hagilight sharing-image fallback. Remove the site component or set seo: { enabled: false }; the Organization and WebSite JSON-LD are still emitted.');
+    }
+    if (options.seo.enabled && options.seo.image === undefined && themeConfig.image === undefined) {
+        warnings.push('Neither themeConfig.image nor seo.image is set, so pages without their own image get no default sharing image. Set one of them, or set seo: { enabled: false }.');
+    }
+    if (options.footer && themeConfig.footer !== undefined) {
+        warnings.push('themeConfig.footer is ignored by the Hagilight footer. Move its links into the links option or set footer: { enabled: false }.');
+    }
+    if (options.googleAnalyticsId !== undefined && (themeConfig.gtag !== undefined || officialGtagConfigured(context.siteConfig))) {
+        warnings.push('Google Analytics would load twice: the site already configures gtag. Remove themeConfig.gtag or the official gtag plugin, or set analytics.googleAnalytics: { enabled: false }.');
+    }
+    return warnings;
+}

package/package.json

@@ -1,6 +1,80 @@
 {
   "name": "@hagicode/hagilight-docusaurus",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0-dev.148.1.e0c630e",
+  "type": "module",
+  "description": "Docusaurus plugin for HagiCode site features: footer, analytics, promote card, locales, SEO, sitemap, robots.txt, and RSS",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/HagiCode-org/hagilight.git",
+    "directory": "packages/docusaurus"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "engines": {
+    "node": ">=24.0.0"
+  },
+  "scripts": {
+    "build": "tsc -b",
+    "prepack": "tsc -b"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./locales": {
+      "types": "./dist/locales.d.ts",
+      "default": "./dist/locales.js"
+    }
+  },
+  "files": [
+    "README.md",
+    "styles.css",
+    "promoto.css",
+    "dist/**/*.js",
+    "dist/**/*.d.ts"
+  ],
+  "dependencies": {
+    "@docusaurus/types": "^3.9.2",
+    "@hagicode/hagilight-core": "0.1.0-dev.148.1.e0c630e"
+  },
+  "peerDependencies": {
+    "@docusaurus/core": "^3.9.2",
+    "@docusaurus/theme-classic": "^3.9.2",
+    "react": "^18.0.0 || ^19.0.0",
+    "react-dom": "^18.0.0 || ^19.0.0"
+  },
+  "devDependencies": {
+    "@docusaurus/core": "^3.9.2",
+    "@docusaurus/module-type-aliases": "^3.9.2",
+    "@docusaurus/theme-classic": "^3.9.2",
+    "@types/react": "^19.0.0",
+    "@types/react-dom": "^19.0.0",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "react-helmet-async": "^3.0.0"
+  },
+  "keywords": [
+    "hagicode",
+    "hagicode-org",
+    "hagilight",
+    "docusaurus",
+    "docusaurus-plugin",
+    "multilingual-documentation",
+    "hreflang",
+    "structured-data",
+    "rss",
+    "sitemap"
+  ],
+  "homepage": "https://github.com/HagiCode-org/hagilight#readme",
+  "bugs": {
+    "url": "https://github.com/HagiCode-org/hagilight/issues"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "HagiCode",
+    "url": "https://github.com/HagiCode-org"
+  }
+}