tycho-components 0.23.8 → 0.23.9

package/dist/configs/index.d.ts

@@ -26,5 +26,5 @@ export { useCorpusUtils } from './useCorpusUtils';
 export { useLoggedUtils } from './useLoggedUtils';
 export { useMessageUtils } from './useMessageUtils';
 export { useTourUtils } from './useTourUtils';
-export { useDriverTour, loadKnowledgeBase, defaultMatchPathnames, buildAnchorMap, flattenWorkflowSteps, getWorkflowsForPath, buildDriveSteps, createTourDriver, hasMatchingWorkflow, resolveAnchor, resolveAnchorById, waitForSelector, } from './tour';
-export type { AnchorSelector, KnowledgeBase, PopoverSide, ResolveKnowledgeBaseUrl, TourAnchor, TourButtonLabels, TourStep, TourWorkflow, UseDriverTourOptions, } from './tour';
+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, KnowledgeBase, KnowledgeBaseRaw, LocalizedString, PopoverSide, ResolveKnowledgeBaseUrl, TourAnchor, TourButtonLabels, TourStep, TourStepCopy, TourStepStructural, TourWorkflow, TourWorkflowRaw, UseDriverTourOptions, } from './tour';

package/dist/configs/index.js

@@ -15,4 +15,4 @@ export { useCorpusUtils } from './useCorpusUtils';
 export { useLoggedUtils } from './useLoggedUtils';
 export { useMessageUtils } from './useMessageUtils';
 export { useTourUtils } from './useTourUtils';
-export { useDriverTour, loadKnowledgeBase, defaultMatchPathnames, buildAnchorMap, flattenWorkflowSteps, getWorkflowsForPath, buildDriveSteps, createTourDriver, hasMatchingWorkflow, resolveAnchor, resolveAnchorById, waitForSelector, } from './tour';
+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/configs/localization/SentenceTexts.d.ts

@@ -1,56 +1,56 @@
 export declare const SentenceTexts: {
     en: {
-        'label.word': string;
-        'label.pos.tag': string;
-        'label.tag': string;
-        'label.morphemes': string;
-        'label.empty': string;
-        'label.tier.original': string;
-        'label.tier.junction': string;
-        'label.tier.segmentation': string;
-        'label.tier.spelling': string;
-        'label.tier.expansion': string;
-        'label.tier.correction': string;
-        'label.tier.punctuation': string;
-        'label.tier.illegible': string;
-        'label.tier.modernization': string;
-        'label.tier.padronization': string;
-        'label.tier.inflection': string;
+        "label.word": string;
+        "label.pos.tag": string;
+        "label.tag": string;
+        "label.morphemes": string;
+        "label.empty": string;
+        "label.tier.original": string;
+        "label.tier.junction": string;
+        "label.tier.segmentation": string;
+        "label.tier.spelling": string;
+        "label.tier.expansion": string;
+        "label.tier.correction": string;
+        "label.tier.punctuation": string;
+        "label.tier.illegible": string;
+        "label.tier.modernization": string;
+        "label.tier.padronization": string;
+        "label.tier.inflection": string;
     };
-    'pt-BR': {
-        'label.word': string;
-        'label.pos.tag': string;
-        'label.tag': string;
-        'label.morphemes': string;
-        'label.empty': string;
-        'label.tier.original': string;
-        'label.tier.junction': string;
-        'label.tier.segmentation': string;
-        'label.tier.spelling': string;
-        'label.tier.expansion': string;
-        'label.tier.correction': string;
-        'label.tier.punctuation': string;
-        'label.tier.illegible': string;
-        'label.tier.modernization': string;
-        'label.tier.padronization': string;
-        'label.tier.inflection': string;
+    "pt-BR": {
+        "label.word": string;
+        "label.pos.tag": string;
+        "label.tag": string;
+        "label.morphemes": string;
+        "label.empty": string;
+        "label.tier.original": string;
+        "label.tier.junction": string;
+        "label.tier.segmentation": string;
+        "label.tier.spelling": string;
+        "label.tier.expansion": string;
+        "label.tier.correction": string;
+        "label.tier.punctuation": string;
+        "label.tier.illegible": string;
+        "label.tier.modernization": string;
+        "label.tier.padronization": string;
+        "label.tier.inflection": string;
     };
     it: {
-        'label.word': string;
-        'label.pos.tag': string;
-        'label.tag': string;
-        'label.morphemes': string;
-        'label.empty': string;
-        'label.tier.original': string;
-        'label.tier.junction': string;
-        'label.tier.segmentation': string;
-        'label.tier.spelling': string;
-        'label.tier.expansion': string;
-        'label.tier.correction': string;
-        'label.tier.punctuation': string;
-        'label.tier.illegible': string;
-        'label.tier.modernization': string;
-        'label.tier.padronization': string;
-        'label.tier.inflection': string;
+        "label.word": string;
+        "label.pos.tag": string;
+        "label.tag": string;
+        "label.morphemes": string;
+        "label.empty": string;
+        "label.tier.original": string;
+        "label.tier.junction": string;
+        "label.tier.segmentation": string;
+        "label.tier.spelling": string;
+        "label.tier.expansion": string;
+        "label.tier.correction": string;
+        "label.tier.punctuation": string;
+        "label.tier.illegible": string;
+        "label.tier.modernization": string;
+        "label.tier.padronization": string;
+        "label.tier.inflection": string;
     };
 };

package/dist/configs/localization/SentenceTexts.js

@@ -1,56 +1,56 @@
 export const SentenceTexts = {
     en: {
-        'label.word': 'Word',
-        'label.pos.tag': 'POS Tag',
-        'label.tag': 'Tag',
-        'label.morphemes': 'Morphemes',
-        'label.empty': '-',
-        'label.tier.original': 'original',
-        'label.tier.junction': 'junction',
-        'label.tier.segmentation': 'segmentation',
-        'label.tier.spelling': 'spelling',
-        'label.tier.expansion': 'expansion',
-        'label.tier.correction': 'correction',
-        'label.tier.punctuation': 'punctuation',
-        'label.tier.illegible': 'illegible',
-        'label.tier.modernization': 'modernization',
-        'label.tier.padronization': 'padronization',
-        'label.tier.inflection': 'inflection',
+        "label.word": "Word",
+        "label.pos.tag": "POS Tag",
+        "label.tag": "Tag",
+        "label.morphemes": "Morphemes",
+        "label.empty": "-",
+        "label.tier.original": "original",
+        "label.tier.junction": "junction",
+        "label.tier.segmentation": "segmentation",
+        "label.tier.spelling": "spelling",
+        "label.tier.expansion": "expansion",
+        "label.tier.correction": "correction",
+        "label.tier.punctuation": "punctuation",
+        "label.tier.illegible": "illegible",
+        "label.tier.modernization": "modernization",
+        "label.tier.padronization": "standardization",
+        "label.tier.inflection": "inflection",
     },
-    'pt-BR': {
-        'label.word': 'Palavra',
-        'label.pos.tag': 'Etiqueta POS',
-        'label.tag': 'Etiqueta',
-        'label.morphemes': 'Morfemas',
-        'label.empty': '-',
-        'label.tier.original': 'original',
-        'label.tier.junction': 'junção',
-        'label.tier.segmentation': 'segmentação',
-        'label.tier.spelling': 'grafia',
-        'label.tier.expansion': 'expansão',
-        'label.tier.correction': 'correção',
-        'label.tier.punctuation': 'pontuação',
-        'label.tier.illegible': 'ilegível',
-        'label.tier.modernization': 'modernização',
-        'label.tier.padronization': 'padronização',
-        'label.tier.inflection': 'flexão',
+    "pt-BR": {
+        "label.word": "Palavra",
+        "label.pos.tag": "Etiqueta POS",
+        "label.tag": "Etiqueta",
+        "label.morphemes": "Morfemas",
+        "label.empty": "-",
+        "label.tier.original": "original",
+        "label.tier.junction": "junção",
+        "label.tier.segmentation": "segmentação",
+        "label.tier.spelling": "grafia",
+        "label.tier.expansion": "expansão",
+        "label.tier.correction": "correção",
+        "label.tier.punctuation": "pontuação",
+        "label.tier.illegible": "ilegível",
+        "label.tier.modernization": "modernização",
+        "label.tier.padronization": "padronização",
+        "label.tier.inflection": "flexão",
     },
     it: {
-        'label.word': 'Parola',
-        'label.pos.tag': 'Etichetta POS',
-        'label.tag': 'Etichetta',
-        'label.morphemes': 'Morfemi',
-        'label.empty': '-',
-        'label.tier.original': 'originale',
-        'label.tier.junction': 'giunzione',
-        'label.tier.segmentation': 'segmentazione',
-        'label.tier.spelling': 'ortografia',
-        'label.tier.expansion': 'espansione',
-        'label.tier.correction': 'correzione',
-        'label.tier.punctuation': 'punteggiatura',
-        'label.tier.illegible': 'illeggibile',
-        'label.tier.modernization': 'modernizzazione',
-        'label.tier.padronization': 'standardizzazione',
-        'label.tier.inflection': 'flessione',
+        "label.word": "Parola",
+        "label.pos.tag": "Etichetta POS",
+        "label.tag": "Etichetta",
+        "label.morphemes": "Morfemi",
+        "label.empty": "-",
+        "label.tier.original": "originale",
+        "label.tier.junction": "giunzione",
+        "label.tier.segmentation": "segmentazione",
+        "label.tier.spelling": "ortografia",
+        "label.tier.expansion": "espansione",
+        "label.tier.correction": "correzione",
+        "label.tier.punctuation": "punteggiatura",
+        "label.tier.illegible": "illeggibile",
+        "label.tier.modernization": "modernizzazione",
+        "label.tier.padronization": "standardizzazione",
+        "label.tier.inflection": "flessione",
     },
 };

package/dist/configs/tour/index.d.ts

@@ -1,5 +1,6 @@
 export { useDriverTour } from './useDriverTour';
 export { buildAnchorMap, defaultMatchPathnames, flattenWorkflowSteps, getWorkflowsForPath, loadKnowledgeBase, } from './knowledgeBase';
 export { buildDriveSteps, createTourDriver, hasMatchingWorkflow, } from './driverTour';
+export { localizeKnowledgeBase, pickLocalizedString, resolveTourLocale, TOUR_FALLBACK_LOCALE, TOUR_LOCALES, } from './localizeKnowledgeBase';
 export { resolveAnchor, resolveAnchorById, waitForSelector, } from './anchorResolver';
-export type { AnchorSelector, KnowledgeBase, PopoverSide, ResolveKnowledgeBaseUrl, TourAnchor, TourButtonLabels, TourStep, TourWorkflow, UseDriverTourOptions, } from './types';
+export type { AnchorSelector, KnowledgeBase, KnowledgeBaseRaw, LocalizedString, PopoverSide, ResolveKnowledgeBaseUrl, TourAnchor, TourButtonLabels, TourStep, TourStepCopy, TourStepStructural, TourWorkflow, TourWorkflowRaw, UseDriverTourOptions, } from './types';

package/dist/configs/tour/index.js

@@ -1,4 +1,5 @@
 export { useDriverTour } from './useDriverTour';
 export { buildAnchorMap, defaultMatchPathnames, flattenWorkflowSteps, getWorkflowsForPath, loadKnowledgeBase, } from './knowledgeBase';
 export { buildDriveSteps, createTourDriver, hasMatchingWorkflow, } from './driverTour';
+export { localizeKnowledgeBase, pickLocalizedString, resolveTourLocale, TOUR_FALLBACK_LOCALE, TOUR_LOCALES, } from './localizeKnowledgeBase';
 export { resolveAnchor, resolveAnchorById, waitForSelector, } from './anchorResolver';

package/dist/configs/tour/localizeKnowledgeBase.d.ts

@@ -0,0 +1,6 @@
+import type { KnowledgeBase, KnowledgeBaseRaw, LocalizedString } from './types';
+export declare const TOUR_LOCALES: readonly ["en", "pt-BR", "it"];
+export declare const TOUR_FALLBACK_LOCALE = "en";
+export declare function resolveTourLocale(language: string): string;
+export declare function pickLocalizedString(value: LocalizedString, locale: string): string;
+export declare function localizeKnowledgeBase(raw: KnowledgeBaseRaw, locale: string): KnowledgeBase;

package/dist/configs/tour/localizeKnowledgeBase.js

@@ -0,0 +1,70 @@
+export const TOUR_LOCALES = ['en', 'pt-BR', 'it'];
+export const TOUR_FALLBACK_LOCALE = 'en';
+const LOCALE_FOLDER_BY_LANGUAGE = {
+    en: 'en',
+    'pt-BR': 'pt-BR',
+    pt: 'pt-BR',
+    it: 'it',
+};
+export function resolveTourLocale(language) {
+    return LOCALE_FOLDER_BY_LANGUAGE[language] ?? language;
+}
+export function pickLocalizedString(value, locale) {
+    if (typeof value === 'string')
+        return value;
+    const folder = resolveTourLocale(locale);
+    return (value[folder] ??
+        value[TOUR_FALLBACK_LOCALE] ??
+        Object.values(value).find((entry) => entry.length > 0) ??
+        '');
+}
+function isLegacyWorkflow(workflow) {
+    if (workflow.copy)
+        return false;
+    return workflow.steps.some((step) => 'title' in step || 'body' in step);
+}
+function pickCopyBlock(copy, locale) {
+    const folder = resolveTourLocale(locale);
+    return (copy[folder] ??
+        copy[TOUR_FALLBACK_LOCALE] ??
+        Object.values(copy).find((block) => block.length > 0) ??
+        []);
+}
+function localizeWorkflow(workflow, locale) {
+    if (isLegacyWorkflow(workflow)) {
+        return {
+            id: workflow.id,
+            title: pickLocalizedString(workflow.title, locale),
+            matchRoute: workflow.matchRoute,
+            steps: workflow.steps,
+        };
+    }
+    const copyBlock = workflow.copy
+        ? pickCopyBlock(workflow.copy, locale)
+        : [];
+    if (copyBlock.length !== workflow.steps.length) {
+        console.error(`Tour workflow "${workflow.id}": copy length (${copyBlock.length}) does not match steps length (${workflow.steps.length}) for locale "${locale}"`);
+    }
+    const steps = workflow.steps.map((structural, index) => {
+        const text = copyBlock[index] ?? { title: '', body: '' };
+        return {
+            anchor: structural.anchor,
+            title: text.title,
+            body: text.body,
+        };
+    });
+    return {
+        id: workflow.id,
+        title: pickLocalizedString(workflow.title, locale),
+        matchRoute: workflow.matchRoute,
+        steps,
+    };
+}
+export function localizeKnowledgeBase(raw, locale) {
+    return {
+        title: pickLocalizedString(raw.title, locale),
+        module: raw.module,
+        anchors: raw.anchors,
+        workflows: raw.workflows.map((workflow) => localizeWorkflow(workflow, locale)),
+    };
+}

package/dist/configs/tour/types.d.ts

@@ -13,6 +13,14 @@ export type TourAnchor = {
     guardClickPanel?: string;
     popoverSide?: PopoverSide;
 };
+export type LocalizedString = string | Record<string, string>;
+export type TourStepCopy = {
+    title: string;
+    body: string;
+};
+export type TourStepStructural = {
+    anchor?: string;
+};
 export type TourStep = {
     title: string;
     body: string;
@@ -24,12 +32,25 @@ export type TourWorkflow = {
     matchRoute: string;
     steps: TourStep[];
 };
+export type TourWorkflowRaw = {
+    id: string;
+    title: LocalizedString;
+    matchRoute: string;
+    steps: TourStepStructural[] | TourStep[];
+    copy?: Record<string, TourStepCopy[]>;
+};
 export type KnowledgeBase = {
     title: string;
     module: string;
     anchors: TourAnchor[];
     workflows: TourWorkflow[];
 };
+export type KnowledgeBaseRaw = {
+    title: LocalizedString;
+    module: string;
+    anchors: TourAnchor[];
+    workflows: TourWorkflowRaw[];
+};
 export type TourButtonLabels = {
     next: string;
     previous: string;

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

@@ -38,7 +38,7 @@ export default function HeaderApps({ navigateLogout, navigateNotLogged, hideKeyb
                                 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 }), 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: 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: 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 }) }) })] }))] }));
 }
 const platformOrigin = (import.meta.env.VITE_APP_ORIGIN ?? "").replace(/\/+$/, "");
 const resources = [

package/dist/shell/Header/HelpButton/HelpModal.js

@@ -66,5 +66,5 @@ export default function HelpModal({ onClose, helpActions = [] }) {
         },
         ...helpActions,
     ];
-    return (_jsxs(AppModal, { title: t('modal.title'), close: onClose, hideFooter: true, className: "help-modal", children: [_jsxs("div", { className: "live-tour", children: [_jsx(AppPicture, { src: liveTour }), _jsxs("div", { className: "tour-content", children: [_jsx("div", { className: "title", children: t('title.tour') }), _jsx("div", { className: "desc", children: t('description.tour') }), _jsxs("label", { className: "help-checkbox-label", children: [_jsx("input", { type: "checkbox", checked: autoOpenEnabled, onChange: handleAutoOpenChange, disabled: updatingLiveTour, className: "help-checkbox" }), _jsx("span", { children: t('checkbox.autoOpen') })] }), _jsx(Button, { text: t('button.tour'), size: "small", icon: "keyboard_arrow_right", onClick: handleTourToggle, disabled: updatingLiveTour })] })] }), _jsx("div", { className: "other-actions", children: actionItems.map((item, idx) => (_jsxs("div", { className: "item", children: [_jsx("div", { className: "title", children: item.title }), _jsx("div", { className: "desc", children: item.desc }), _jsx(Button, { text: t('button.open'), size: "x-small", mode: "outlined", icon: "keyboard_arrow_right", onClick: () => handleCustomAction(item) })] }, idx))) })] }));
+    return (_jsxs(AppModal, { title: t('modal.title'), close: onClose, hideFooter: true, className: "help-modal", children: [_jsxs("div", { className: "live-tour", children: [_jsx(AppPicture, { src: liveTour }), _jsxs("div", { className: "tour-content", children: [_jsx("div", { className: "title", children: t('title.tour') }), _jsx("div", { className: "desc", children: t('description.tour') }), _jsxs("label", { className: "help-checkbox-label", children: [_jsx("input", { type: "checkbox", checked: autoOpenEnabled, onChange: handleAutoOpenChange, disabled: updatingLiveTour, className: "help-checkbox" }), _jsx("span", { children: t('checkbox.autoOpen') })] }), _jsx(Button, { text: t('button.tour'), size: "small", icon: "keyboard_arrow_right", onClick: handleTourToggle, disabled: updatingLiveTour, "data-tour": "guided-tour-start" })] })] }), _jsx("div", { className: "other-actions", children: actionItems.map((item, idx) => (_jsxs("div", { className: "item", children: [_jsx("div", { className: "title", children: item.title }), _jsx("div", { className: "desc", children: item.desc }), _jsx(Button, { text: t('button.open'), size: "x-small", mode: "outlined", icon: "keyboard_arrow_right", onClick: () => handleCustomAction(item) })] }, idx))) })] }));
 }

package/package.json

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