sass-cms-template-common 0.0.2 → 0.0.4

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { AnchorHTMLAttributes } from 'react';
+import { AxiosInstance } from 'axios';
 import { ElementType } from 'react';
 import { ForwardRefExoticComponent } from 'react';
 import { JSX } from 'react';
@@ -8,11 +9,12 @@ import { Theme } from '@mui/material/styles';
 
 /**
  * Navegación lateral por defecto.
- * `module` debe coincidir exactamente con `module` en POST /auth/modulesAvailable.
+ * `module` debe coincidir exactamente con `module` en POST /auth/modulesAvailable
+ * y con las claves en `messages.navigation`.
  */
 export declare const ACCOUNT_NAV_BLOCKS: NavBlock[];
 
-export declare function AppShell({ pathname, sites, children, notificationUnreadCount, notifications, profile, primaryLogo, brandLogo, selectedPublicationId, getPublicationHref, resolvePublicationImageUrl, profileAvatarOptions, LinkComponent, permissions, }: AppShellProps): JSX.Element;
+export declare function AppShell({ pathname, sites, children, notificationUnreadCount, notifications, profile, primaryLogo, brandLogo, selectedPublicationId, getPublicationHref, resolvePublicationImageUrl, profileAvatarOptions, LinkComponent, permissions, locale, language, messages, baseUrl, }: AppShellProps): JSX.Element;
 
 export declare type AppShellProps = {
     pathname: string;
@@ -23,12 +25,48 @@ export declare type AppShellProps = {
     profile: ProfileGetResponse;
     primaryLogo: ReactNode;
     brandLogo?: ReactNode;
-    selectedPublicationId?: string;
+    selectedPublicationId: string;
     getPublicationHref: (publication: Publication) => string;
     resolvePublicationImageUrl?: (imagePath: string) => string;
     profileAvatarOptions?: ProfileAvatarOptions;
     LinkComponent?: CmsLinkComponent;
     permissions: Array<NavItemPermissions>;
+    locale?: Locale | string;
+    /** Alias de `locale`. */
+    language?: Locale | string;
+    messages?: CmsMessagesOverride;
+    baseUrl: string;
+};
+
+/** Credenciales de sesión CMS usadas por los servicios HTTP. */
+export declare type Authentication = {
+    browserId: string;
+    project: string;
+    publication: number;
+    siteName: string;
+    token: string;
+};
+
+export declare class CmsCommonServices {
+    protected props: ICommonServices;
+    protected authentication: Authentication;
+    constructor(props: ICommonServices);
+    getDefaultPublication: () => Promise<Publication>;
+    getProfile: () => Promise<ProfileGetResponse>;
+    getCountNotifications: () => Promise<CountNotificationsResponse>;
+    getNotifications: () => Promise<NotificationsListResponse>;
+    getSitesAndPublications: () => Promise<SitesAndPublicationsResult>;
+}
+
+export declare function CmsI18nProvider({ locale, language, messages, catalog, children, }: CmsI18nProviderProps): JSX.Element;
+
+export declare type CmsI18nProviderProps = {
+    locale?: Locale | string;
+    /** Alias de `locale` (p. ej. consumidores que pasan `language="es"`). */
+    language?: Locale | string;
+    messages?: CmsMessagesOverride;
+    catalog?: LocaleCatalog;
+    children: ReactNode;
 };
 
 export declare type CmsLinkComponent = ElementType<CmsLinkProps & RefAttributes<HTMLAnchorElement>>;
@@ -38,6 +76,14 @@ export declare type CmsLinkProps = AnchorHTMLAttributes<HTMLAnchorElement> & {
     children?: ReactNode;
 };
 
+/** Message tree shape; values are strings, keys are inferred from `enMessages`. */
+export declare type CmsMessages = DeepStringMap<typeof enMessages>;
+
+/** Partial override tree; missing keys fall back to the active locale, then `en`. */
+export declare type CmsMessagesOverride = {
+    [Namespace in keyof CmsMessages]?: Partial<CmsMessages[Namespace]>;
+};
+
 /** Provider MUI sin integración Next.js (playground Vite u otros frameworks). */
 export declare function CmsMuiProvider({ children }: CmsMuiProviderProps): JSX.Element;
 
@@ -45,15 +91,28 @@ export declare type CmsMuiProviderProps = {
     children: ReactNode;
 };
 
+export declare type CmsTranslator = {
+    messages: CmsMessages;
+    navigation: (module: NavigationModule | string) => string;
+    sidebar: (key: SidebarMessageKey) => string;
+    topBar: (key: TopBarMessageKey) => string;
+    profileMenu: (key: ProfileMenuMessageKey) => string;
+    notificationsMenu: (key: NotificationsMenuMessageKey, params?: {
+        count?: number;
+    }) => string;
+};
+
 /** POST /dashboard/countNotificatio */
 export declare interface CountNotificationsResponse {
     status: string;
     count: number;
-    unread?: number;
+    unreadNotifications?: number;
 }
 
 export declare function createAppTheme(): Theme;
 
+export declare function createTranslator(messages: CmsMessages): CmsTranslator;
+
 export declare interface DashboardNotification {
     id: string;
     title: string;
@@ -64,6 +123,14 @@ export declare interface DashboardNotification {
     href?: string;
 }
 
+declare type DeepStringMap<T> = {
+    [K in keyof T]: T[K] extends Record<string, unknown> ? {
+        [K2 in keyof T[K]]: string;
+    } : string;
+};
+
+export declare const DEFAULT_LOCALE: Locale;
+
 export declare const DEFAULT_SITE_ID = "bluestack-es";
 
 export declare const DefaultCmsLink: ForwardRefExoticComponent<AnchorHTMLAttributes<HTMLAnchorElement> & {
@@ -71,6 +138,144 @@ href: string;
 children?: ReactNode;
 } & RefAttributes<HTMLAnchorElement>>;
 
+export declare const defaultLocaleCatalog: LocaleCatalog;
+
+export declare const enMessages: {
+    readonly navigation: {
+        readonly COMMENTS: "Comments";
+        readonly POLLS: "Polls";
+        readonly MEDIA: "Media";
+        readonly AUDIOS: "Audio";
+        readonly IMAGES: "Images";
+        readonly PLAYLISTS: "Playlist";
+        readonly VIDEOS: "Videos";
+        readonly NEWS: "News";
+        readonly PLANNING: "Planning";
+        readonly ANALYTICS: "Analytics";
+        readonly TAGS: "Tags";
+        readonly TRIVIAS: "Trivia";
+        readonly OTHERS: "Other";
+        readonly NEWSWIRES: "News Wires";
+        readonly EVENTS: "Events";
+        readonly PAGES: "Pages";
+        readonly FEEDS: "Feed";
+        readonly PERSONS: "People";
+        readonly CONTRIBUTIONS: "Contributions";
+        readonly RECIPES: "Recipes";
+        readonly POSTS: "Posts";
+        readonly BANNERS: "Banners";
+        readonly BLOCKS: "Blocks";
+        readonly MENUS: "Menu";
+        readonly TOPICS: "Topics";
+        readonly ADVANCEDQUERYS: "Advanced search";
+        readonly IMPORTS: "Imports";
+        readonly NEWSLETTERS: "Newsletters";
+        readonly NOTIFICATIONS: "Notifications";
+        readonly PAYMENTS: "Payments";
+        readonly PLANS: "Plans";
+        readonly REPORTS: "Reports";
+        readonly SECTIONS: "Sections";
+        readonly TWITTERS: "Twitter Feeds";
+        readonly USERS: "Users";
+        readonly ZONES: "Zones";
+        readonly IA: "IA";
+    };
+    readonly sidebar: {
+        readonly navAriaLabel: "Main navigation";
+        readonly collapse: "Collapse";
+        readonly expand: "Expand";
+        readonly newBadge: "New";
+    };
+    readonly topBar: {
+        readonly openSidebar: "Open sidebar menu";
+        readonly closeSidebar: "Close sidebar menu";
+        readonly new: "New";
+        readonly language: "Language";
+        readonly analytics: "Analytics";
+        readonly help: "Help";
+    };
+    readonly profileMenu: {
+        readonly ariaLabel: "My profile";
+        readonly myProfile: "My Profile";
+        readonly webmasterView: "Webmaster View";
+        readonly signOff: "Sign off";
+    };
+    readonly notificationsMenu: {
+        readonly title: "Notifications";
+        readonly unreadCount: "{count} unread";
+        readonly empty: "No notifications";
+        readonly ariaLabel: "Notifications";
+    };
+};
+
+export declare const esMessages: {
+    navigation: {
+        COMMENTS: string;
+        POLLS: string;
+        MEDIA: string;
+        AUDIOS: string;
+        IMAGES: string;
+        PLAYLISTS: string;
+        VIDEOS: string;
+        NEWS: string;
+        PLANNING: string;
+        ANALYTICS: string;
+        TAGS: string;
+        TRIVIAS: string;
+        OTHERS: string;
+        NEWSWIRES: string;
+        EVENTS: string;
+        PAGES: string;
+        FEEDS: string;
+        PERSONS: string;
+        CONTRIBUTIONS: string;
+        RECIPES: string;
+        POSTS: string;
+        BANNERS: string;
+        BLOCKS: string;
+        MENUS: string;
+        TOPICS: string;
+        ADVANCEDQUERYS: string;
+        IMPORTS: string;
+        NEWSLETTERS: string;
+        NOTIFICATIONS: string;
+        PAYMENTS: string;
+        PLANS: string;
+        REPORTS: string;
+        SECTIONS: string;
+        TWITTERS: string;
+        USERS: string;
+        ZONES: string;
+        IA: string;
+    };
+    sidebar: {
+        navAriaLabel: string;
+        collapse: string;
+        expand: string;
+        newBadge: string;
+    };
+    topBar: {
+        openSidebar: string;
+        closeSidebar: string;
+        new: string;
+        language: string;
+        analytics: string;
+        help: string;
+    };
+    profileMenu: {
+        ariaLabel: string;
+        myProfile: string;
+        webmasterView: string;
+        signOff: string;
+    };
+    notificationsMenu: {
+        title: string;
+        unreadCount: string;
+        empty: string;
+        ariaLabel: string;
+    };
+};
+
 export declare function findPublicationBySlug(sites: SiteSection[], slug: string): Publication | undefined;
 
 export declare function findPublicationLabel(sites: SiteSection[], publicationId: string): string;
@@ -79,31 +284,54 @@ export declare function getAllPublications(sites: SiteSection[]): Publication[];
 
 export declare function getDefaultPublicationSlug(sites: SiteSection[]): string;
 
+/** BCP 47 tag for `Intl` / `toLocaleString` formatting. */
+export declare function getIntlLocaleTag(locale: Locale): string;
+
 export declare function getProfileAvatarSrc(profile: ProfileGetResponse, options?: ProfileAvatarOptions): string;
 
 export declare function getProfileDisplayName(profile: ProfileGetResponse): string;
 
+declare interface ICommonServices {
+    axiosApi: AxiosInstance;
+    authentication: Authentication;
+}
+
 export declare const ITEM_DEFAULT_BG = "#FFFFFF";
 
 export declare const ITEM_HOVER_BG = "#D8E2FF";
 
 export declare const LIB_VERSION: "0.0.0";
 
+export declare type Locale = (typeof SUPPORTED_LOCALES)[number];
+
+export declare type LocaleCatalog = Record<Locale, CmsMessages>;
+
 export declare const MENU_BG = "#ECEDF6";
 
+/** Deep-merge custom overrides on top of the locale catalog entry. */
+export declare function mergeMessages(locale: Locale, catalog: LocaleCatalog, overrides?: CmsMessagesOverride): CmsMessages;
+
+/** Cuerpo de la respuesta de POST /auth/modulesAvailable */
+export declare interface ModulesAvailableResponse {
+    modules: NavItemPermissions[];
+}
+
 export declare type NavBlock = NavLinkItem;
 
+export declare type NavigationModule = keyof CmsMessages['navigation'];
+
 export declare type NavItemPermissions = {
     module: string;
-    isNew: boolean;
+    isnew: boolean;
 };
 
 export declare type NavLinkItem = {
-    label: string;
     href: string;
     icon: ElementType;
     /** Clave de POST /auth/modulesAvailable (p. ej. `NEWSWIRES`, `MENUS`) */
     module: string;
+    /** Override opcional del label traducido vía i18n (`navigation.{module}`). */
+    label?: string;
     badge?: string;
     children?: NavLinkItem[];
     defaultOpen?: boolean;
@@ -115,6 +343,9 @@ export declare type NextCmsMuiProviderProps = {
     children: ReactNode;
 };
 
+/** Normaliza códigos BCP 47 o variantes (`es-MX`, `pt_BR`) al `Locale` soportado. */
+export declare function normalizeLocale(value?: string | null): Locale;
+
 export declare type NotificationSeverity = 'info' | 'warning' | 'error' | 'success';
 
 /** POST /dashboard/notification */
@@ -126,6 +357,8 @@ export declare interface NotificationsListResponse {
 
 export declare function NotificationsMenu({ unreadCount, notifications, }: NotificationsMenuProps): JSX.Element;
 
+export declare type NotificationsMenuMessageKey = keyof CmsMessages['notificationsMenu'];
+
 export declare type NotificationsMenuProps = {
     unreadCount: number;
     notifications: DashboardNotification[];
@@ -171,11 +404,82 @@ export declare interface ProfileGetResponse {
 
 export declare function ProfileMenu({ profile, avatarOptions }: ProfileMenuProps): JSX.Element;
 
+export declare type ProfileMenuMessageKey = keyof CmsMessages['profileMenu'];
+
 export declare type ProfileMenuProps = {
     profile: ProfileGetResponse;
     avatarOptions?: ProfileAvatarOptions;
 };
 
+export declare const ptMessages: {
+    navigation: {
+        COMMENTS: string;
+        POLLS: string;
+        MEDIA: string;
+        AUDIOS: string;
+        IMAGES: string;
+        PLAYLISTS: string;
+        VIDEOS: string;
+        NEWS: string;
+        PLANNING: string;
+        ANALYTICS: string;
+        TAGS: string;
+        TRIVIAS: string;
+        OTHERS: string;
+        NEWSWIRES: string;
+        EVENTS: string;
+        PAGES: string;
+        FEEDS: string;
+        PERSONS: string;
+        CONTRIBUTIONS: string;
+        RECIPES: string;
+        POSTS: string;
+        BANNERS: string;
+        BLOCKS: string;
+        MENUS: string;
+        TOPICS: string;
+        ADVANCEDQUERYS: string;
+        IMPORTS: string;
+        NEWSLETTERS: string;
+        NOTIFICATIONS: string;
+        PAYMENTS: string;
+        PLANS: string;
+        REPORTS: string;
+        SECTIONS: string;
+        TWITTERS: string;
+        USERS: string;
+        ZONES: string;
+        IA: string;
+    };
+    sidebar: {
+        navAriaLabel: string;
+        collapse: string;
+        expand: string;
+        newBadge: string;
+    };
+    topBar: {
+        openSidebar: string;
+        closeSidebar: string;
+        new: string;
+        language: string;
+        analytics: string;
+        help: string;
+    };
+    profileMenu: {
+        ariaLabel: string;
+        myProfile: string;
+        webmasterView: string;
+        signOff: string;
+    };
+    notificationsMenu: {
+        title: string;
+        unreadCount: string;
+        empty: string;
+        ariaLabel: string;
+    };
+};
+
+/** Publicación devuelta por POST /publications/get y POST /publications/default */
 export declare interface Publication {
     baseURL: string;
     ckeditor: string;
@@ -194,6 +498,7 @@ export declare interface Publication {
     hasZoneJson: PublicationZoneConfig;
     id: number;
     imagePath: string;
+    /** Nombre del campo tal como viene del API */
     languaje: string;
     mercado: string;
     name: string;
@@ -208,6 +513,7 @@ export declare interface Publication {
     updateAdmin: PublicationUpdateAdmin;
 }
 
+/** Permisos de la publicación en el CMS */
 export declare interface PublicationPermissions {
     hasAccess: boolean;
     NEWS_EDIT: boolean;
@@ -215,11 +521,13 @@ export declare interface PublicationPermissions {
     [key: string]: boolean;
 }
 
+/** Cuerpo de la respuesta de POST /publications/get */
 export declare interface PublicationsGetResponse {
     status: string;
     publications: Publication[];
 }
 
+/** Banner / actualizaciones de administración */
 export declare interface PublicationUpdateAdmin {
     rebootBannerDate: string;
     rebootBannerDurationMin: string;
@@ -229,6 +537,7 @@ export declare interface PublicationUpdateAdmin {
     updateBannerVFSLink: boolean;
 }
 
+/** Zonas por publicación (hasZoneJson) */
 export declare interface PublicationZoneConfig {
     home: boolean;
     section: boolean;
@@ -241,15 +550,33 @@ export declare function resolveCmsAssetUrl(path: string, cmsOrigin?: string): st
 
 export declare function resolveCmsOrigin(cmsOrigin?: string): string;
 
-export declare function Sidebar({ open, pathname, permissions, LinkComponent, }: SidebarProps): JSX.Element;
+export declare function Sidebar({ open, pathname, permissions, LinkComponent, baseUrl, selectedPublicationId, }: SidebarProps): JSX.Element;
+
+export declare type SidebarMessageKey = keyof CmsMessages['sidebar'];
 
 export declare type SidebarProps = {
-    open: boolean;
+    open?: boolean;
     pathname: string;
     LinkComponent?: CmsLinkComponent;
     permissions: Array<NavItemPermissions>;
+    baseUrl: string;
+    selectedPublicationId: string;
 };
 
+/** Entrada de sitio devuelta por POST /sites/get */
+export declare interface Site {
+    /** Slug del sitio; cadena vacía para la raíz */
+    name: string;
+    /** Etiqueta visible (p. ej. "Generic Site 1", "Laboratorio") */
+    title: string;
+}
+
+/** Resultado de combinar sitios, publicaciones y módulos disponibles */
+export declare interface SitesAndPublicationsResult {
+    sites: SiteSection[];
+    modules: NavItemPermissions[];
+}
+
 export declare type SiteSection = {
     title: string;
     publications: Publication[];
@@ -265,8 +592,22 @@ export declare type SiteSelectorMenuProps = {
     resolvePublicationImageUrl?: (imagePath: string) => string;
 };
 
+/** Cuerpo de la respuesta de POST /sites/get */
+export declare interface SitesGetResponse {
+    /** Ruta del sitio activo (p. ej. "/sites/generic1") */
+    root: string;
+    /** Misma ruta que `root`; el API la repite con esta clave */
+    'root.': string;
+    status: string;
+    sites: Site[];
+}
+
+export declare const SUPPORTED_LOCALES: readonly ["es", "en", "pt"];
+
 export declare function TopBar({ sites, sidebarOpen, onToggleSidebar, notificationUnreadCount, notifications, profile, primaryLogo, brandLogo, selectedPublicationId, getPublicationHref, resolvePublicationImageUrl, profileAvatarOptions, }: TopBarProps): JSX.Element;
 
+export declare type TopBarMessageKey = keyof CmsMessages['topBar'];
+
 export declare type TopBarProps = {
     sites: SiteSection[];
     sidebarOpen: boolean;
@@ -282,4 +623,15 @@ export declare type TopBarProps = {
     profileAvatarOptions?: ProfileAvatarOptions;
 };
 
+export declare function useCmsTranslation(options?: UseCmsTranslationOptions): {
+    locale: "es" | "en" | "pt";
+    t: CmsTranslator;
+};
+
+export declare type UseCmsTranslationOptions = {
+    locale?: Locale;
+    messages?: CmsMessagesOverride;
+    catalog?: LocaleCatalog;
+};
+
 export { }