sass-cms-template-common 0.0.0

package/README.md

@@ -0,0 +1,129 @@
+# React + TypeScript + Vite
+
+## Requisitos
+
+Este proyecto usa **Vite 8**, que necesita **Node.js 20.19+** o **22.12+**. Con versiones anteriores (por ejemplo 20.18) falla el arranque por bindings nativos de `rolldown`.
+
+```bash
+nvm use          # lee .nvmrc (Node 22)
+rm -rf node_modules package-lock.json
+npm install
+npm run dev
+```
+
+## Modo librería
+
+Paquete ESM para compartir código entre apps CMS. El código público vive en `src/lib/` y se exporta desde `src/index.ts`. `src/App.tsx` y `src/main.tsx` son solo playground de desarrollo.
+
+```bash
+npm run build    # genera dist/ (JS + tipos)
+```
+
+### Contenido compartido (`src/lib`)
+
+| Área | Descripción |
+|------|-------------|
+| `components/shell` | `AppShell` (layout sidebar + topbar) |
+| `components/sidebar` | `Sidebar` genérico (recibe `navBlocks`) |
+| `components/top-bar` | `TopBar`, `NotificationsMenu`, `ProfileMenu` |
+| `components/site-selector-menu` | Selector de publicación |
+| `components/mui-provider` | `CmsMuiProvider`, `NextCmsMuiProvider` |
+| `theme/` | `createAppTheme` + tokens Material |
+| `types/` | Contratos API/UI (publicación, perfil, notificaciones, navegación) |
+| `utils/` | URLs CMS, avatar, utilidades de sitios/publicaciones |
+
+Lo **específico de cada app** (rutas del sidebar, logos Next/Image, acciones server) queda en el proyecto consumidor.
+
+### Consumir en otro proyecto (monorepo)
+
+En `package.json` del consumidor:
+
+```json
+{
+  "dependencies": {
+    "sass-cms-template-common": "file:../sass-cms-template-common"
+  }
+}
+```
+
+Luego instala y importa:
+
+```ts
+import { LIB_VERSION } from 'sass-cms-template-common'
+```
+
+`react` y `react-dom` son **peer dependencies**; el proyecto host debe proveerlas.
+
+---
+
+This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+
+Currently, two official plugins are available:
+
+- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Oxc](https://oxc.rs)
+- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/)
+
+## React Compiler
+
+The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see [this documentation](https://react.dev/learn/react-compiler/installation).
+
+## Expanding the ESLint configuration
+
+If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
+
+```js
+export default defineConfig([
+  globalIgnores(['dist']),
+  {
+    files: ['**/*.{ts,tsx}'],
+    extends: [
+      // Other configs...
+
+      // Remove tseslint.configs.recommended and replace with this
+      tseslint.configs.recommendedTypeChecked,
+      // Alternatively, use this for stricter rules
+      tseslint.configs.strictTypeChecked,
+      // Optionally, add this for stylistic rules
+      tseslint.configs.stylisticTypeChecked,
+
+      // Other configs...
+    ],
+    languageOptions: {
+      parserOptions: {
+        project: ['./tsconfig.node.json', './tsconfig.app.json'],
+        tsconfigRootDir: import.meta.dirname,
+      },
+      // other options...
+    },
+  },
+])
+```
+
+You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
+
+```js
+// eslint.config.js
+import reactX from 'eslint-plugin-react-x'
+import reactDom from 'eslint-plugin-react-dom'
+
+export default defineConfig([
+  globalIgnores(['dist']),
+  {
+    files: ['**/*.{ts,tsx}'],
+    extends: [
+      // Other configs...
+      // Enable lint rules for React
+      reactX.configs['recommended-typescript'],
+      // Enable lint rules for React DOM
+      reactDom.configs.recommended,
+    ],
+    languageOptions: {
+      parserOptions: {
+        project: ['./tsconfig.node.json', './tsconfig.app.json'],
+        tsconfigRootDir: import.meta.dirname,
+      },
+      // other options...
+    },
+  },
+])
+```

package/dist/index.d.ts

@@ -0,0 +1,274 @@
+import { AnchorHTMLAttributes } from 'react';
+import { ElementType } from 'react';
+import { ForwardRefExoticComponent } from 'react';
+import { JSX } from 'react';
+import { ReactNode } from 'react';
+import { RefAttributes } from 'react';
+import { Theme } from '@mui/material/styles';
+
+export declare function AppShell({ pathname, sites, children, notificationUnreadCount, notifications, profile, navBlocks, primaryLogo, brandLogo, selectedPublicationId, getPublicationHref, resolvePublicationImageUrl, profileAvatarOptions, LinkComponent, }: AppShellProps): JSX.Element;
+
+export declare type AppShellProps = {
+    pathname: string;
+    sites: SiteSection[];
+    children: ReactNode;
+    notificationUnreadCount: number;
+    notifications: DashboardNotification[];
+    profile: ProfileGetResponse;
+    navBlocks: NavBlock[];
+    primaryLogo: ReactNode;
+    brandLogo?: ReactNode;
+    selectedPublicationId?: string;
+    getPublicationHref: (publication: Publication) => string;
+    resolvePublicationImageUrl?: (imagePath: string) => string;
+    profileAvatarOptions?: ProfileAvatarOptions;
+    LinkComponent?: CmsLinkComponent;
+};
+
+export declare type CmsLinkComponent = ElementType<CmsLinkProps & RefAttributes<HTMLAnchorElement>>;
+
+export declare type CmsLinkProps = AnchorHTMLAttributes<HTMLAnchorElement> & {
+    href: string;
+    children?: ReactNode;
+};
+
+/** Provider MUI sin integración Next.js (playground Vite u otros frameworks). */
+export declare function CmsMuiProvider({ children }: CmsMuiProviderProps): JSX.Element;
+
+export declare type CmsMuiProviderProps = {
+    children: ReactNode;
+};
+
+/** POST /dashboard/countNotificatio */
+export declare interface CountNotificationsResponse {
+    status: string;
+    count: number;
+    unread?: number;
+}
+
+export declare function createAppTheme(): Theme;
+
+export declare interface DashboardNotification {
+    id: string;
+    title: string;
+    message: string;
+    severity: NotificationSeverity;
+    read: boolean;
+    createdAt: string;
+    href?: string;
+}
+
+export declare const DEFAULT_SITE_ID = "bluestack-es";
+
+export declare const DefaultCmsLink: ForwardRefExoticComponent<AnchorHTMLAttributes<HTMLAnchorElement> & {
+href: string;
+children?: ReactNode;
+} & RefAttributes<HTMLAnchorElement>>;
+
+export declare function findPublicationBySlug(sites: SiteSection[], slug: string): Publication | undefined;
+
+export declare function findPublicationLabel(sites: SiteSection[], publicationId: string): string;
+
+export declare function getAllPublications(sites: SiteSection[]): Publication[];
+
+export declare function getDefaultPublicationSlug(sites: SiteSection[]): string;
+
+export declare function getProfileAvatarSrc(profile: ProfileGetResponse, options?: ProfileAvatarOptions): string;
+
+export declare function getProfileDisplayName(profile: ProfileGetResponse): string;
+
+export declare const ITEM_DEFAULT_BG = "#FFFFFF";
+
+export declare const ITEM_HOVER_BG = "#D8E2FF";
+
+export declare const LIB_VERSION: "0.0.0";
+
+export declare const MENU_BG = "#ECEDF6";
+
+export declare type NavBlock = NavLinkItem[] | {
+    divider: true;
+};
+
+export declare type NavLinkItem = {
+    label: string;
+    href: string;
+    icon: ElementType;
+    badge?: string;
+    children?: NavLinkItem[];
+    defaultOpen?: boolean;
+};
+
+export declare function NextCmsMuiProvider({ children }: NextCmsMuiProviderProps): JSX.Element;
+
+export declare type NextCmsMuiProviderProps = {
+    children: ReactNode;
+};
+
+export declare type NotificationSeverity = 'info' | 'warning' | 'error' | 'success';
+
+/** POST /dashboard/notification */
+export declare interface NotificationsListResponse {
+    status: string;
+    notifications: DashboardNotification[];
+    total?: number;
+}
+
+export declare function NotificationsMenu({ unreadCount, notifications, }: NotificationsMenuProps): JSX.Element;
+
+export declare type NotificationsMenuProps = {
+    unreadCount: number;
+    notifications: DashboardNotification[];
+};
+
+export declare function parsePublicationSlug(slug: string): number;
+
+export declare interface ProfileAdditionalInfoField {
+    name: string;
+    type: ProfileFieldType;
+    options: string[];
+    categoryPath: string;
+    depends: string;
+}
+
+export declare type ProfileAvatarOptions = {
+    cmsOrigin?: string;
+    fallbackAvatar?: string;
+};
+
+export declare type ProfileFieldType = 'string' | 'textarea' | 'date' | 'option' | 'category';
+
+/** POST /profile/get */
+export declare interface ProfileGetResponse {
+    status: string;
+    creationDate: string;
+    defaultPublication: string;
+    defaultSite: string;
+    email: string;
+    firstName: string;
+    fullName: string;
+    image: string;
+    lastName: string;
+    locale: string;
+    userName: string;
+    userStatus: string;
+    viewNews: string;
+    viewPins: string;
+    imageAllowedFileTypes: string;
+    additionalInfo: ProfileAdditionalInfoField[];
+    documentation: unknown[];
+}
+
+export declare function ProfileMenu({ profile, avatarOptions }: ProfileMenuProps): JSX.Element;
+
+export declare type ProfileMenuProps = {
+    profile: ProfileGetResponse;
+    avatarOptions?: ProfileAvatarOptions;
+};
+
+export declare interface Publication {
+    baseURL: string;
+    ckeditor: string;
+    customDomain?: string;
+    dateFormat: string;
+    description: string;
+    gmtRedaction: string;
+    gmtRedactionName: string;
+    gmtServer: string;
+    gmtServerName: string;
+    googleApiKey: string;
+    hasCategory: boolean;
+    hasCategoryData: string;
+    hasComplianceActive: boolean;
+    hasZone: boolean;
+    hasZoneJson: PublicationZoneConfig;
+    id: number;
+    imagePath: string;
+    languaje: string;
+    mercado: string;
+    name: string;
+    newsFormTarget: string;
+    permitions: PublicationPermissions;
+    pinedMax: string;
+    publication: number;
+    site: string;
+    sitio: string;
+    timeFormat: string;
+    type: string;
+    updateAdmin: PublicationUpdateAdmin;
+}
+
+export declare interface PublicationPermissions {
+    hasAccess: boolean;
+    NEWS_EDIT: boolean;
+    NEWS_SHARE: boolean;
+    [key: string]: boolean;
+}
+
+export declare interface PublicationsGetResponse {
+    status: string;
+    publications: Publication[];
+}
+
+export declare interface PublicationUpdateAdmin {
+    rebootBannerDate: string;
+    rebootBannerDurationMin: string;
+    rebootBannerEnable: boolean;
+    updateBannerEnable: boolean;
+    updateBannerLink: string;
+    updateBannerVFSLink: boolean;
+}
+
+export declare interface PublicationZoneConfig {
+    home: boolean;
+    section: boolean;
+    defaultPublication: string;
+    entro: number;
+    zones: unknown[];
+}
+
+export declare function resolveCmsAssetUrl(path: string, cmsOrigin?: string): string;
+
+export declare function resolveCmsOrigin(cmsOrigin?: string): string;
+
+export declare function Sidebar({ open, pathname, navBlocks, LinkComponent, }: SidebarProps): JSX.Element;
+
+export declare type SidebarProps = {
+    open: boolean;
+    pathname: string;
+    navBlocks: NavBlock[];
+    LinkComponent?: CmsLinkComponent;
+};
+
+export declare type SiteSection = {
+    title: string;
+    publications: Publication[];
+    fullWidth?: boolean;
+};
+
+export declare function SiteSelectorMenu({ sites, selectedPublicationId, getPublicationHref, resolvePublicationImageUrl, }: SiteSelectorMenuProps): JSX.Element;
+
+export declare type SiteSelectorMenuProps = {
+    sites: SiteSection[];
+    selectedPublicationId?: string;
+    getPublicationHref: (publication: Publication) => string;
+    resolvePublicationImageUrl?: (imagePath: string) => string;
+};
+
+export declare function TopBar({ sites, sidebarOpen, onToggleSidebar, notificationUnreadCount, notifications, profile, primaryLogo, brandLogo, selectedPublicationId, getPublicationHref, resolvePublicationImageUrl, profileAvatarOptions, }: TopBarProps): JSX.Element;
+
+export declare type TopBarProps = {
+    sites: SiteSection[];
+    sidebarOpen: boolean;
+    onToggleSidebar: () => void;
+    notificationUnreadCount: number;
+    notifications: DashboardNotification[];
+    profile: ProfileGetResponse;
+    primaryLogo: ReactNode;
+    brandLogo?: ReactNode;
+    selectedPublicationId?: string;
+    getPublicationHref: (publication: Publication) => string;
+    resolvePublicationImageUrl?: (imagePath: string) => string;
+    profileAvatarOptions?: ProfileAvatarOptions;
+};
+
+export { }