prometeo-design-system 3.1.7 → 4.0.0

package/dist/components/PyrionNavigationDrawer/PLayoutBase.d.ts

@@ -0,0 +1,41 @@
+import { ReactElement, ReactNode } from 'react';
+import { NavigationDrawerActionItemProps } from '../NavigationDrawer/NavigationDrawerActionItem';
+import { NavigationDrawerLinkItemProps } from '../NavigationDrawer/NavigationDrawerLinkItem';
+import { TabSwitchElement } from '../TabSwitch/TabSwitch';
+import { TicketCardHandlerProps } from '../TicketCard';
+import { NotificationsListControlsHandler } from './PLNotificationsList';
+import { PLSidebarContentHandle } from './PLSidebarContent';
+import { AuthSession, PyrionNavigationControls, PyrionNavigationDrawerOptions, PyrionNavigationDrawerProps } from './PyrionLayout';
+export type TLayoutBaseProps<TAppMetadata = unknown, TNotificationMetadata = unknown> = {
+    links?: NavigationDrawerLinkItemProps[];
+    handleNavigation: (path: string) => void;
+    allActions: NavigationDrawerActionItemProps[];
+    activeActionId?: string;
+    onActionClick?: (id: string, payload?: any) => void;
+    state: PyrionNavigationDrawerProps<TAppMetadata, TNotificationMetadata>['state'];
+    currentAppSessions: AuthSession<TAppMetadata>[];
+    resolveUserSecondarySlot: (metadata?: TAppMetadata) => ReactNode | string | null;
+    resolveSessionSecondarySlot: (session: AuthSession<TAppMetadata>) => ReactNode | string | null;
+    onSessionClick?: (session: AuthSession<TAppMetadata>) => void;
+    onLogoutClick?: () => void;
+    options?: PyrionNavigationDrawerOptions<TAppMetadata>;
+    currentSystemId: string;
+    userOptionsControls: React.RefObject<TicketCardHandlerProps | null>;
+    mobileAppSwitcherControls: React.RefObject<TicketCardHandlerProps | null>;
+    onSystemLogoClick?: (collapsed?: boolean) => void;
+    tabs: TabSwitchElement[];
+    helpSection?: ReactNode | (() => ReactNode);
+    sidebarContentRef: React.RefObject<PLSidebarContentHandle | null>;
+    initialSectionRef: React.RefObject<'notifications' | 'help'>;
+    navigationControlsRef: React.RefObject<PyrionNavigationControls<TNotificationMetadata>>;
+    notificationsListControls?: React.RefObject<NotificationsListControlsHandler<TNotificationMetadata> | null>;
+    outletRef: React.RefObject<HTMLDivElement | null>;
+};
+type LayoutBaseComponent = <TAppMetadata = unknown, TNotificationMetadata = unknown>(props: TLayoutBaseProps<TAppMetadata, TNotificationMetadata> & {
+    children?: ReactNode;
+}) => ReactElement;
+type LayoutBaseMemoComponent = LayoutBaseComponent & {
+    displayName?: string;
+};
+declare const LayoutBase: LayoutBaseMemoComponent;
+export default LayoutBase;

package/dist/components/PyrionNavigationDrawer/PyrionLayout.d.ts

@@ -0,0 +1,143 @@
+import { default as React, ReactNode } from 'react';
+import { NavigationDrawerActionItemProps } from '../NavigationDrawer/NavigationDrawerActionItem';
+import { NavigationDrawerLinkItemProps } from '../NavigationDrawer/NavigationDrawerLinkItem';
+import { NotificationCardProps } from '../NotificationCard/NotificationCard';
+import { AllOptionAccessor } from '../Shared/types';
+import { TabSwitchElement } from '../TabSwitch/TabSwitch';
+import { subImageUrlAccessor } from './PLSystemSessions';
+import { NavigationDrawerSidebarProps } from '../NavigationDrawer/NavigationDrawerSidebar';
+type TProduct = {
+    name: string;
+    domain: string;
+    active: boolean;
+    coverImage?: string;
+    thumbnail?: string;
+};
+type TCompany = {
+    name: string;
+    products?: TProduct[];
+    icon?: string;
+};
+type TUser = {
+    _id: string;
+    name: string;
+    surname?: string;
+    email?: string;
+    profile_picture?: string;
+};
+type TAuthUser = TUser & {
+    company: TCompany;
+};
+export type TSystem = {
+    name: string;
+    url: string;
+    coverImage?: string;
+    thumbnail?: string;
+    _id: string;
+};
+export interface AuthSession<TAppMetadata> {
+    _id: string;
+    token: string;
+    expires_at: string;
+    logoutDate?: string;
+    auth_id: TAuthUser;
+    metadata?: TAppMetadata;
+}
+export interface NavigationDrawerTabsProps {
+    currentTabName?: string;
+    customTabs?: TabSwitchElement[];
+    onTabClick?: (name: string) => void;
+}
+type AvailableData<TAppMetadata> = {
+    company: TCompany;
+    user: TUser;
+    system?: TSystem;
+    metadata?: TAppMetadata;
+};
+type SessionAvailableData<TAppMetadata> = {
+    company: TCompany;
+    user: TAuthUser;
+    system?: TSystem;
+    metadata?: TAppMetadata;
+};
+type MetadataFallback<T> = unknown extends T ? `metadata${string}` : never;
+type UserCardAccesors<TAppMetadata> = AllOptionAccessor<AvailableData<TAppMetadata>, string> | MetadataFallback<TAppMetadata>;
+type SessionCardAccesors<TAppMetadata> = AllOptionAccessor<SessionAvailableData<TAppMetadata>, string> | MetadataFallback<TAppMetadata>;
+interface UserCardOptions<TAppMetadata> {
+    secondarySlot: UserCardAccesors<TAppMetadata> | [UserCardAccesors<TAppMetadata>, UserCardAccesors<TAppMetadata>] | ((data: AvailableData<TAppMetadata>) => React.ReactNode);
+}
+interface SessionCardOptions<TAppMetadata> {
+    secondarySlot: SessionCardAccesors<TAppMetadata> | [SessionCardAccesors<TAppMetadata>, SessionCardAccesors<TAppMetadata>] | ((data: SessionAvailableData<TAppMetadata>) => React.ReactNode);
+    subImageUrlAccessor?: subImageUrlAccessor<TAppMetadata>;
+}
+export interface NotificationsDrawerOptions {
+    hide?: boolean;
+    hideActionButton?: boolean;
+    onMarkAllAsRead?: () => void;
+}
+export interface HelpSectionDrawerOptions {
+    hide?: boolean;
+    hideActionButton?: boolean;
+}
+export interface ConfigurationActionOptions {
+    hideActionButton?: boolean;
+    onClick: VoidFunction;
+}
+export interface PyrionNavigationDrawerOptions<TAppMetadata> {
+    userCardOptions?: UserCardOptions<TAppMetadata>;
+    sessionCardOptions?: SessionCardOptions<TAppMetadata>;
+    notificationsDrawerOptions?: NotificationsDrawerOptions;
+    helpSectionDrawerOptions?: HelpSectionDrawerOptions;
+    configurationActionOptions?: ConfigurationActionOptions;
+    sidebarOptions: Pick<NavigationDrawerSidebarProps, 'modal' | 'closeOnOverlayClick'>;
+    disableDragOpen?: {
+        drawer?: boolean;
+        sidebar?: boolean;
+    };
+}
+export interface PyrionNavigationDrawerProps<TAppMetadata, TNotificationMetadata = unknown> {
+    links?: NavigationDrawerLinkItemProps[];
+    actions?: NavigationDrawerActionItemProps[];
+    tabsProps?: NavigationDrawerTabsProps;
+    activeActionId?: string;
+    currentSystemId: string;
+    helpSection?: ReactNode | (() => ReactNode);
+    children?: ReactNode;
+    state: {
+        company: TCompany;
+        enabled_systems: TSystem[];
+        user: TUser;
+        sessions?: AuthSession<TAppMetadata>[];
+        metadata?: TAppMetadata;
+    };
+    options?: PyrionNavigationDrawerOptions<TAppMetadata>;
+    onActionClick?: (id: string, payload?: any) => void;
+    onLinkClick?: (path: string) => void;
+    onSessionClick?: (session: AuthSession<TAppMetadata>) => void;
+    onNavigate?: (from: string, to: string) => void;
+    onSystemLogoClick?: (collapsed?: boolean) => void;
+    onLogoutClick?: () => void;
+}
+export type PyrionNavigationControls<TNotificationMetadata = unknown> = {
+    toggleCollapse?: () => void;
+    getIsCollapsed?: () => boolean;
+    subscribeToCollapse?: (listener: (collapsed: boolean) => void) => () => void;
+    openSidebar?: () => void;
+    closeSidebar?: () => void;
+    toggleSidebar?: () => void;
+    getIsSidebarOpen?: () => boolean;
+    subscribeToSidebarOpen?: (listener: (open: boolean) => void) => () => void;
+    setDrawerDragEnabled?: (enabled: boolean) => void;
+    setSidebarDragEnabled?: (enabled: boolean) => void;
+    openHelp?: () => void;
+    openNotifications?: () => void;
+    showErrorModal?: (disableDrawer: boolean) => void;
+    addNewNotification?: (notification: NotificationCardProps<TNotificationMetadata> | NotificationCardProps<TNotificationMetadata>[]) => void;
+    subscribeToNotificationsUpdates?: (callback: (notifications: NotificationCardProps<TNotificationMetadata>[], count: number) => void) => () => void;
+    setNotifications?: (notifications: NotificationCardProps<TNotificationMetadata>[]) => void;
+    removeAllNotifications?: () => void;
+    removeNotification?: (id: string | string[]) => void;
+};
+export declare const usePyrionNavigation: <TNotificationMetadata = unknown>() => PyrionNavigationControls<TNotificationMetadata>;
+declare const PyrionNavigationDrawer: <TAppMetadata = unknown, TNotificationMetadata = unknown>({ children, helpSection, state, links: navlinks, onLinkClick, onNavigate, onLogoutClick, actions, activeActionId, onActionClick, tabsProps, currentSystemId, onSessionClick, options, onSystemLogoClick }: PyrionNavigationDrawerProps<TAppMetadata, TNotificationMetadata>) => import("react/jsx-runtime").JSX.Element;
+export default PyrionNavigationDrawer;

package/dist/components/PyrionNavigationDrawer/index.d.ts

@@ -1,3 +1,4 @@
-import { default as PyrionNavigationDrawer, PyrionNavigationDrawerProps, PyrionNavigationDrawerOptions, NavigationDrawerTabsProps, AuthSession } from './PyrionNavigationDrawer';
-export { type PyrionNavigationDrawerProps, type PyrionNavigationDrawerOptions, type NavigationDrawerTabsProps, type AuthSession };
+import { default as PyrionNavigationDrawer, PyrionNavigationDrawerProps, PyrionNavigationDrawerOptions, NavigationDrawerTabsProps, AuthSession } from './PyrionLayout';
+import { NotificationCardProps } from '../NotificationCard';
+export { type PyrionNavigationDrawerProps, type PyrionNavigationDrawerOptions, type NavigationDrawerTabsProps, type AuthSession, type NotificationCardProps };
 export default PyrionNavigationDrawer;

package/dist/components/Scrollable/Scrollable.d.ts

@@ -26,6 +26,7 @@ export interface ScrollableProps {
     scrollbarProps?: ScrollbarProps;
     disableMouseScroll?: boolean;
     defaultBehavior?: 'scroll-on-click' | 'scroll-on-hover' | 'none';
+    persistScroll?: boolean | string;
 }
 declare const Scrollable: (props: ScrollableProps) => import("react/jsx-runtime").JSX.Element;
 export default Scrollable;

package/dist/exports/PyrionLayout.d.ts

@@ -0,0 +1,2 @@
+export { default } from '../components/PyrionNavigationDrawer';
+export { type PyrionNavigationDrawerProps, type PyrionNavigationDrawerOptions, type NavigationDrawerTabsProps, type AuthSession, type NotificationCardProps } from '../components/PyrionNavigationDrawer';

package/dist/exports/usePyrionNavigation.d.ts

@@ -1 +1 @@
-export { usePyrionNavigation as default } from '../components/PyrionNavigationDrawer/PyrionNavigationDrawer';
+export { usePyrionNavigation as default } from '../components/PyrionNavigationDrawer/PyrionLayout';