tycho-components 0.43.6 → 0.44.0

package/dist/configs/brand.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Build-time whitelabel: name, logo, favicon only.
+ * Brand packs are served at site root: {VITE_APP_ORIGIN}/brands/{id}/
+ * (not bundled per app — upload packs on each host / shared nginx).
+ */
+export type BrandId = 'tycho' | 'corpushub';
+export type AppCode = 'admin' | 'auth' | 'cs-analyzer' | 'dictionary' | 'editor' | 'io' | 'lexicon' | 'parser' | 'psd-reindexer' | 'reserved' | 'search' | 'syntrees' | 'viewer';
+export type BrandConfig = {
+    id: BrandId;
+    name: string;
+    completeName: string;
+    logo: string;
+    documentTitle: string;
+    /** Absolute URL prefix: https://host/brands/{id} */
+    faviconBase: string;
+    socialMedia?: {
+        youtube?: string;
+    };
+};
+export declare function brandAssetBase(brandId: BrandId, originRaw: string | undefined): string;
+/**
+ * Resolve platform branding for a front-end app.
+ * Pass `options` from Vite plugins (Node) where `import.meta.env` may be unavailable.
+ */
+export declare function createBrand(app: AppCode, options?: {
+    brandId?: string;
+    origin?: string;
+}): BrandConfig;
+/** Shared helper for tests / tooling. */
+export declare function brandFromEnv(raw: string | undefined): BrandId;

package/dist/configs/brand.js

@@ -0,0 +1,85 @@
+/**
+ * Build-time whitelabel: name, logo, favicon only.
+ * Brand packs are served at site root: {VITE_APP_ORIGIN}/brands/{id}/
+ * (not bundled per app — upload packs on each host / shared nginx).
+ */
+const APP_TITLE_SUFFIX = {
+    admin: 'Admin',
+    auth: 'Auth',
+    'cs-analyzer': 'CS Analyzer',
+    dictionary: 'Dictionary',
+    editor: 'Editor',
+    io: 'IO',
+    lexicon: 'Lexicon',
+    parser: 'Parser',
+    'psd-reindexer': 'PSD Re-Indexer',
+    reserved: 'Reserved Area',
+    search: 'Search',
+    syntrees: 'Syntrees',
+    viewer: 'Viewer',
+};
+const DEFAULT_YOUTUBE = 'https://www.youtube.com/@tychoplatform';
+function trimOrigin(raw) {
+    return (raw || '').replace(/\/+$/, '');
+}
+export function brandAssetBase(brandId, originRaw) {
+    const origin = trimOrigin(originRaw);
+    if (!origin) {
+        // Last resort for misconfigured builds — prefer setting VITE_APP_ORIGIN.
+        return `/brands/${brandId}`;
+    }
+    return `${origin}/brands/${brandId}`;
+}
+function resolveBrandId(raw) {
+    return raw?.toLowerCase() === 'corpushub' ? 'corpushub' : 'tycho';
+}
+function readEnvBrandId() {
+    try {
+        return import.meta.env?.VITE_APP_BRAND;
+    }
+    catch {
+        return undefined;
+    }
+}
+function readEnvOrigin() {
+    try {
+        return import.meta.env?.VITE_APP_ORIGIN;
+    }
+    catch {
+        return undefined;
+    }
+}
+/**
+ * Resolve platform branding for a front-end app.
+ * Pass `options` from Vite plugins (Node) where `import.meta.env` may be unavailable.
+ */
+export function createBrand(app, options) {
+    const id = resolveBrandId(options?.brandId ?? readEnvBrandId());
+    const origin = options?.origin ?? readEnvOrigin();
+    const faviconBase = brandAssetBase(id, origin);
+    const suffix = APP_TITLE_SUFFIX[app];
+    const meta = id === 'corpushub'
+        ? {
+            name: 'CorpusHub',
+            completeName: 'CorpusHub',
+            documentTitle: `CorpusHub - ${suffix}`,
+        }
+        : {
+            name: 'Tycho',
+            completeName: 'Tycho Platform',
+            documentTitle: `Tycho Platform - ${suffix}`,
+        };
+    return {
+        id,
+        ...meta,
+        faviconBase,
+        logo: `${faviconBase}/logo.png`,
+        socialMedia: {
+            youtube: DEFAULT_YOUTUBE,
+        },
+    };
+}
+/** Shared helper for tests / tooling. */
+export function brandFromEnv(raw) {
+    return resolveBrandId(raw);
+}

package/dist/configs/index.d.ts

@@ -35,5 +35,7 @@ export { useCorpusUtils } from "./useCorpusUtils";
 export { useLoggedUtils } from "./useLoggedUtils";
 export { useMessageUtils } from "./useMessageUtils";
 export { useTourUtils } from "./useTourUtils";
+export { brandAssetBase, brandFromEnv, createBrand, } from "./brand";
+export type { AppCode, BrandConfig, BrandId } from "./brand";
 export { useDriverTour, loadKnowledgeBase, defaultMatchPathnames, buildAnchorMap, flattenWorkflowSteps, getWorkflowsForPath, buildDriveSteps, createTourDriver, hasMatchingWorkflow, resolveAnchor, resolveAnchorById, waitForSelector, localizeKnowledgeBase, pickLocalizedString, resolveTourLocale, TOUR_FALLBACK_LOCALE, TOUR_LOCALES, } from "./tour";
 export type { AnchorSelector, Driver, KnowledgeBase, KnowledgeBaseRaw, LocalizedString, PopoverSide, ResolveKnowledgeBaseUrl, TourAnchor, TourButtonLabels, TourStep, TourStepCopy, TourStepStructural, TourWorkflow, TourWorkflowRaw, UseDriverTourOptions, } from "./tour";

package/dist/configs/index.js

@@ -19,4 +19,5 @@ export { useCorpusUtils } from "./useCorpusUtils";
 export { useLoggedUtils } from "./useLoggedUtils";
 export { useMessageUtils } from "./useMessageUtils";
 export { useTourUtils } from "./useTourUtils";
+export { brandAssetBase, brandFromEnv, createBrand, } from "./brand";
 export { useDriverTour, loadKnowledgeBase, defaultMatchPathnames, buildAnchorMap, flattenWorkflowSteps, getWorkflowsForPath, buildDriveSteps, createTourDriver, hasMatchingWorkflow, resolveAnchor, resolveAnchorById, waitForSelector, localizeKnowledgeBase, pickLocalizedString, resolveTourLocale, TOUR_FALLBACK_LOCALE, TOUR_LOCALES, } from "./tour";

package/dist/shell/Header/Header.d.ts

@@ -1,5 +1,7 @@
 import { HelpAction } from './HelpButton/HelpButton';
+import type { HeaderBrand, HeaderSocialMedia } from './types/Brand';
 import './styles.scss';
+export type { HeaderBrand, HeaderSocialMedia } from './types/Brand';
 type Props = {
     tool: string;
     redirect?: string;
@@ -22,12 +24,9 @@ type Props = {
     hideNotifications?: boolean;
     hideLanguageSelector?: boolean;
     hideHelpButton?: boolean;
-    /** Overrides i18n `label.platform` (e.g. CorpusHub whitelabel). */
-    platformName?: string;
-    /** Overrides i18n `label.platform.complete` in the apps drawer. */
-    platformCompleteName?: string;
-    /** Overrides the apps-drawer platform tile image. */
-    platformLogo?: string;
+    /** Overrides i18n platform labels and apps-drawer logo (e.g. CorpusHub whitelabel). */
+    brand?: HeaderBrand;
+    /** Optional social links shown in the apps drawer Quick section. */
+    socialMedia?: HeaderSocialMedia;
 };
-export default function Header({ tool, redirect, autoload, hideKeyboard, customHeader, notifications, keyboardLayout, navigateHome, navigateCorpora, navigateLogout, navigateNotLogged, helpActions, useOpenCorpora, hideCorpora, hideNotifications, hideLanguageSelector, hideHelpButton, platformName, platformCompleteName, platformLogo, }: Props): import("react").JSX.Element;
-export {};
+export default function Header({ tool, redirect, autoload, hideKeyboard, customHeader, notifications, keyboardLayout, navigateHome, navigateCorpora, navigateLogout, navigateNotLogged, helpActions, useOpenCorpora, hideCorpora, hideNotifications, hideLanguageSelector, hideHelpButton, brand, socialMedia, }: Props): import("react").JSX.Element;

package/dist/shell/Header/Header.js

@@ -8,10 +8,10 @@ import HeaderUser from './HeaderUser';
 import './styles.scss';
 export default function Header({ tool, redirect, autoload, hideKeyboard, customHeader, notifications, keyboardLayout, navigateHome, navigateCorpora, navigateLogout, navigateNotLogged = () => {
     location.href = '/auth';
-}, helpActions, useOpenCorpora = true, hideCorpora = false, hideNotifications = false, hideLanguageSelector = false, hideHelpButton = false, platformName, platformCompleteName, platformLogo, }) {
+}, helpActions, useOpenCorpora = true, hideCorpora = false, hideNotifications = false, hideLanguageSelector = false, hideHelpButton = false, brand, socialMedia, }) {
     const { t } = useTranslation('header');
     const homeTextsClass = cx('app-title', {
         pointer: navigateHome !== undefined,
     });
-    return (_jsxs("div", { className: "ds-header", children: [_jsxs("div", { className: "header-left", children: [_jsx(HeaderApps, { navigateLogout: navigateLogout, navigateNotLogged: navigateNotLogged, hideKeyboard: hideKeyboard, notifications: notifications, keyboardLayout: keyboardLayout, helpActions: helpActions, platformCompleteName: platformCompleteName, platformLogo: platformLogo }), _jsxs("div", { className: homeTextsClass, onClick: () => navigateHome && navigateHome(), children: [_jsx("span", { className: "title", children: platformName ?? t('label.platform') }), _jsx("span", { className: "subtitle", children: tool })] }), _jsxs("div", { className: "header-corpus", children: [!hideCorpora && (_jsx(HeaderCorpora, { redirect: redirect, autoload: autoload, navigateCorpora: navigateCorpora, useOpenCorpora: useOpenCorpora })), customHeader && customHeader] })] }), _jsxs("div", { className: "header-right", children: [_jsx(HeaderButtons, { hideKeyboard: hideKeyboard, notifications: notifications, keyboardLayout: keyboardLayout, helpActions: helpActions, hideNotifications: hideNotifications, hideLanguageSelector: hideLanguageSelector, hideHelpButton: hideHelpButton }), _jsx(HeaderUser, { navigateLogout: navigateLogout, navigateNotLogged: navigateNotLogged })] })] }));
+    return (_jsxs("div", { className: "ds-header", children: [_jsxs("div", { className: "header-left", children: [_jsx(HeaderApps, { navigateLogout: navigateLogout, navigateNotLogged: navigateNotLogged, hideKeyboard: hideKeyboard, notifications: notifications, keyboardLayout: keyboardLayout, helpActions: helpActions, brand: brand, socialMedia: socialMedia }), _jsxs("div", { className: homeTextsClass, onClick: () => navigateHome && navigateHome(), children: [_jsx("span", { className: "title", children: brand?.name ?? t('label.platform') }), _jsx("span", { className: "subtitle", children: tool })] }), _jsxs("div", { className: "header-corpus", children: [!hideCorpora && (_jsx(HeaderCorpora, { redirect: redirect, autoload: autoload, navigateCorpora: navigateCorpora, useOpenCorpora: useOpenCorpora })), customHeader && customHeader] })] }), _jsxs("div", { className: "header-right", children: [_jsx(HeaderButtons, { hideKeyboard: hideKeyboard, notifications: notifications, keyboardLayout: keyboardLayout, helpActions: helpActions, hideNotifications: hideNotifications, hideLanguageSelector: hideLanguageSelector, hideHelpButton: hideHelpButton }), _jsx(HeaderUser, { navigateLogout: navigateLogout, navigateNotLogged: navigateNotLogged })] })] }));
 }

package/dist/shell/Header/HeaderApps/HeaderApps.d.ts

@@ -1,4 +1,5 @@
 import { HelpAction } from "../HelpButton/HelpButton";
+import type { HeaderBrand, HeaderSocialMedia } from "../types/Brand";
 import "./style.scss";
 type Props = {
     navigateLogout?: () => void;
@@ -10,8 +11,8 @@ type Props = {
     };
     keyboardLayout?: string;
     helpActions?: HelpAction[];
-    platformCompleteName?: string;
-    platformLogo?: string;
+    brand?: HeaderBrand;
+    socialMedia?: HeaderSocialMedia;
 };
-export default function HeaderApps({ navigateLogout, navigateNotLogged, hideKeyboard, notifications, keyboardLayout, helpActions, platformCompleteName, platformLogo, }: Props): import("react").JSX.Element;
+export default function HeaderApps({ navigateLogout, navigateNotLogged, hideKeyboard, notifications, keyboardLayout, helpActions, brand, socialMedia, }: Props): import("react").JSX.Element;
 export {};

package/dist/shell/Header/HeaderApps/HeaderApps.js

@@ -11,7 +11,7 @@ import { AvailableApps } from "../types/App";
 import logo from "./logo.png";
 import youtube from "./youtube.png";
 import "./style.scss";
-export default function HeaderApps({ navigateLogout, navigateNotLogged, hideKeyboard, notifications, keyboardLayout, helpActions, platformCompleteName, platformLogo, }) {
+export default function HeaderApps({ navigateLogout, navigateNotLogged, hideKeyboard, notifications, keyboardLayout, helpActions, brand, socialMedia, }) {
     const { t } = useTranslation("header-app");
     const { getCorpus, hasCorpus } = useCorpusUtils();
     const { isAdminOfAnyCorpus, isEditorOfAnyCorpus, isLogged } = useLoggedUtils();
@@ -20,22 +20,33 @@ export default function HeaderApps({ navigateLogout, navigateNotLogged, hideKeyb
     const resources = [
         {
             code: "platform",
-            image: platformLogo || logo,
+            image: brand?.logo || logo,
             visibility: "public",
             external: platformOrigin || undefined,
         },
-        {
-            code: "youtube",
-            image: youtube,
-            visibility: "public",
-            external: "https://www.youtube.com/@tychoplatform",
-        },
+        ...(socialMedia?.youtube
+            ? [
+                {
+                    code: "youtube",
+                    image: youtube,
+                    visibility: "public",
+                    external: socialMedia.youtube,
+                },
+            ]
+            : []),
     ];
     const goto = (app, blank) => {
-        const shouldAppendCorpusUid = app.appendCorpusUid !== false;
-        const url = hasCorpus() && shouldAppendCorpusUid
-            ? `/${app.code}/${getCorpus().uid}`
-            : `/${app.code}`;
+        let url;
+        if (app.external) {
+            url = app.external;
+        }
+        else {
+            const shouldAppendCorpusUid = app.appendCorpusUid !== false;
+            url =
+                hasCorpus() && shouldAppendCorpusUid
+                    ? `/${app.code}/${getCorpus().uid}`
+                    : `/${app.code}`;
+        }
         if (blank) {
             window.open(url, "_blank");
         }
@@ -50,12 +61,12 @@ export default function HeaderApps({ navigateLogout, navigateNotLogged, hideKeyb
             return null;
         if (item.editor && !isEditorOfAnyCorpus())
             return null;
-        return (_jsxs("div", { className: "item", title: t(`${item.code}.desc`), onClick: () => goto(item, item.external ? true : false), children: [item.icon && _jsx(Icon, { name: item.icon, size: "medium" }), item.image && _jsx("img", { src: item.image }), _jsx("span", { className: "title-app", children: item.code === "platform" && platformCompleteName
-                        ? platformCompleteName
+        return (_jsxs("div", { className: "item", title: t(`${item.code}.desc`), onClick: () => goto(item, item.external ? true : false), children: [item.icon && _jsx(Icon, { name: item.icon, size: "medium" }), item.image && _jsx("img", { src: item.image }), _jsx("span", { className: "title-app", children: item.code === "platform" && brand?.completeName
+                        ? brand.completeName
                         : t(`${item.code}.name`) }), _jsxs("div", { className: "options", children: [item.visibility && (_jsx(Tag, { text: t(`common:label.${item.visibility}`), size: "small", color: "green", className: "d-none" })), _jsx(IconButton, { name: "open_in_new", size: "x-small", className: "icon-open", mode: "ghost", onClick: (e) => {
                                 e.stopPropagation();
                                 goto(item, true);
                             }, title: t("label.open.tab") })] })] }, idx.valueOf()));
     };
-    return (_jsxs("div", { className: "header-apps-container", children: [_jsx(IconButton, { name: "apps", className: "icon-apps", size: "large", onClick: () => setOpen(!open), filledIcon: true, "data-tour": "header-apps" }), open && (_jsxs(Drawer, { anchor: "left", open: true, onClose: () => setOpen(false), className: "offcanvas-apps", children: [_jsxs("div", { className: "header", children: [_jsx(IconButton, { name: "close", size: "medium", mode: "ghost", iconSize: "medium", onClick: () => setOpen(false) }), _jsx("span", { className: "header-apps-title", children: platformCompleteName ?? t("header:label.platform.complete") }), _jsx("div", { className: "header-profile-apps", children: _jsx(HeaderUser, { navigateLogout: navigateLogout, navigateNotLogged: navigateNotLogged }) })] }), _jsxs("div", { className: "body", children: [_jsx("div", { className: "title", children: t("label.tools") }), AvailableApps.map((item, idx) => renderItem(item, idx)), _jsx("div", { className: "title", children: t("label.quick") }), resources.map((item, idx) => renderItem(item, idx))] }), _jsx("div", { className: "footer", children: _jsx("div", { className: "header-apps-buttons", children: _jsx(HeaderButtons, { hideKeyboard: hideKeyboard, notifications: notifications, keyboardLayout: keyboardLayout, helpActions: helpActions, mobile: true }) }) })] }))] }));
+    return (_jsxs("div", { className: "header-apps-container", children: [_jsx(IconButton, { name: "apps", className: "icon-apps", size: "large", onClick: () => setOpen(!open), filledIcon: true, "data-tour": "header-apps" }), open && (_jsxs(Drawer, { anchor: "left", open: true, onClose: () => setOpen(false), className: "offcanvas-apps", children: [_jsxs("div", { className: "header", children: [_jsx(IconButton, { name: "close", size: "medium", mode: "ghost", iconSize: "medium", onClick: () => setOpen(false) }), _jsx("span", { className: "header-apps-title", children: brand?.completeName ?? t("header:label.platform.complete") }), _jsx("div", { className: "header-profile-apps", children: _jsx(HeaderUser, { navigateLogout: navigateLogout, navigateNotLogged: navigateNotLogged }) })] }), _jsxs("div", { className: "body", children: [_jsx("div", { className: "title", children: t("label.tools") }), AvailableApps.map((item, idx) => renderItem(item, idx)), _jsx("div", { className: "title", children: t("label.quick") }), resources.map((item, idx) => renderItem(item, idx))] }), _jsx("div", { className: "footer", children: _jsx("div", { className: "header-apps-buttons", children: _jsx(HeaderButtons, { hideKeyboard: hideKeyboard, notifications: notifications, keyboardLayout: keyboardLayout, helpActions: helpActions, mobile: true }) }) })] }))] }));
 }

package/dist/shell/Header/types/Brand.d.ts

@@ -0,0 +1,8 @@
+export type HeaderBrand = {
+    name?: string;
+    completeName?: string;
+    logo?: string;
+};
+export type HeaderSocialMedia = {
+    youtube?: string;
+};

package/dist/shell/Header/types/Brand.js

@@ -0,0 +1 @@
+export {};

package/dist/shell/index.d.ts

@@ -5,6 +5,7 @@ export { default as Logout } from './Base/Logout';
 export { default as NotFound } from './Base/NotFound';
 export { default as Unauthorized } from './Base/Unauthorized';
 export { default as Header } from './Header';
+export type { HeaderBrand, HeaderSocialMedia } from './Header/types/Brand';
 export { default as HeaderCorpus } from './Header/HeaderCorpora/HeaderCorpus';
 export { default as HelpButton } from './Header/HelpButton';
 export type { HelpAction } from './Header/HelpButton/HelpButton';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "tycho-components",
   "private": false,
-  "version": "0.43.6",
+  "version": "0.44.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "exports": {