@fastr-pro/global-header 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,235 @@
+import * as React from 'react';
+
+export interface UserSubscription {
+  name?: string;
+  app_name?: string;
+  code?: string;
+  app_code?: string;
+  status?: string;
+  subscription_status?: string;
+  [key: string]: any;
+}
+
+export interface UserApp {
+  id?: string | number;
+  name?: string;
+  app_name?: string;
+  code?: string;
+  role?: string;
+  subscription_status?: string;
+  is_subscribed?: boolean;
+  app_url?: string;
+  [key: string]: any;
+}
+
+export interface User {
+  id?: string | number;
+  name?: string;
+  full_name?: string;
+  fullName?: string;
+  email?: string;
+  role?: string;
+  is_superadmin?: boolean;
+  subscriptions?: UserSubscription[] | Record<string, any>;
+  apps?: UserApp[];
+  all_apps?: UserApp[];
+  [key: string]: any;
+}
+
+export interface AppUrls {
+  landing?: string;
+  sso?: string;
+  purchase?: string;
+  profile?: string;
+  xray?: string;
+  scanner?: string;
+  charting?: string;
+  macro?: string;
+  derivatives?: string;
+  [key: string]: string | undefined;
+}
+
+export interface AppItemConfig {
+  id: string;
+  title?: string;
+  name?: string;
+  label?: string;
+  desc?: string;
+  description?: string;
+  route?: string;
+  href?: string;
+  hash?: string;
+  queryParams?: Record<string, string | number | boolean | undefined>;
+  params?: Record<string, string | number | boolean | undefined>;
+  indicator?: string;
+  icon?: React.ComponentType<any> | React.ReactNode;
+  badge?: string;
+  badgeColor?: string;
+  onClick?: (item: AppItemConfig, page: AppPageConfig, app: AppConfig) => void;
+  [key: string]: any;
+}
+
+export interface AppPageConfig {
+  id: string;
+  label?: string;
+  title?: string;
+  name?: string;
+  value?: string;
+  route?: string;
+  href?: string;
+  hash?: string;
+  queryParams?: Record<string, string | number | boolean | undefined>;
+  params?: Record<string, string | number | boolean | undefined>;
+  icon?: React.ComponentType<any> | React.ReactNode;
+  description?: string;
+  sections?: AppItemConfig[];
+  items?: AppItemConfig[];
+  dbName?: string;
+  dbId?: string;
+  onClick?: (page: AppPageConfig, app: AppConfig) => void;
+  [key: string]: any;
+}
+
+export interface QuickActionConfig {
+  id: string;
+  title?: string;
+  label?: string;
+  icon?: React.ComponentType<any> | React.ReactNode;
+  route?: string;
+  href?: string;
+  hash?: string;
+  queryParams?: Record<string, string | number | boolean | undefined>;
+  params?: Record<string, string | number | boolean | undefined>;
+  badgeColor?: string;
+  onClick?: (action: QuickActionConfig, app: AppConfig) => void;
+  [key: string]: any;
+}
+
+export interface AppConfig {
+  id: string;
+  name?: string;
+  label?: string;
+  url?: string;
+  href?: string;
+  route?: string;
+  hash?: string;
+  queryParams?: Record<string, string | number | boolean | undefined>;
+  params?: Record<string, string | number | boolean | undefined>;
+  icon?: React.ComponentType<any> | React.ReactNode;
+  bannerImage?: string;
+  badge?: string;
+  badgeColor?: string;
+  footerNote?: string;
+  menuHeader?: string;
+  categoriesHeader?: string;
+  description?: string;
+  hasMegaMenu?: boolean;
+  quickActions?: QuickActionConfig[];
+  pages?: AppPageConfig[];
+  categories?: AppPageConfig[];
+  onClick?: (app: AppConfig) => void;
+  [key: string]: any;
+}
+
+export interface HeaderConfig {
+  authApiUrl?: string;
+  authRedirectUrl?: string;
+  profileGetter?: (() => Promise<User | any> | User | any) | null;
+  uiTheme?: 'light' | 'dark' | 'system' | string;
+  currentApp?: string;
+  themeParamName?: string;
+  appendThemeParam?: boolean;
+  user?: User | null;
+  logout?: (() => void | Promise<void>) | null;
+  urls?: AppUrls;
+  apps?: Record<string, AppConfig> | AppConfig[];
+  [key: string]: any;
+}
+
+export interface GlobalHeaderProps {
+  config?: HeaderConfig;
+  authApiUrl?: string;
+  authRedirectUrl?: string;
+  profileGetter?: () => Promise<User | any> | User | any;
+  uiTheme?: 'light' | 'dark' | 'system' | string;
+  apps?: Record<string, AppConfig> | AppConfig[];
+  user?: User | null;
+  logout?: () => void;
+  theme?: 'light' | 'dark' | 'system';
+  setTheme?: (theme: 'light' | 'dark' | 'system') => void;
+  currentApp?: 'derivatives' | 'xray' | 'scanner' | 'charting' | 'macro' | string;
+  navigate?: (path: string) => void;
+  onNavigate?: (path: string, app?: AppConfig, item?: AppItemConfig) => void;
+  urls?: AppUrls;
+  logo?: React.ReactNode;
+  onLogoClick?: () => void;
+  categoryData?: any[];
+  chartingCallbacks?: {
+    onSelectCandleType?: (id: string) => void;
+    onSelectIndicator?: (id: string) => void;
+    onSelectPattern?: (id: string) => void;
+    onSelectCondition?: (id: string) => void;
+    onSelectInterval?: (id: string) => void;
+  };
+  products?: any[];
+  extraRightContent?: React.ReactNode;
+  className?: string;
+}
+
+export declare const GlobalHeader: React.FC<GlobalHeaderProps>;
+export default GlobalHeader;
+
+export interface GlobalMegaMenuProps {
+  app?: AppConfig;
+  type?: string;
+  config?: HeaderConfig;
+  currentApp?: string;
+  isDarkMode?: boolean;
+  isSubscribed?: boolean;
+  purchaseUrl?: string;
+  categoryData?: any[];
+  theme?: string;
+  onClose?: () => void;
+  onNavigate?: (path: string, app?: AppConfig, item?: any) => void;
+  urls?: AppUrls;
+  onSelectCandleType?: (id: string) => void;
+  onSelectIndicator?: (id: string) => void;
+  onSelectPattern?: (id: string) => void;
+  onSelectCondition?: (id: string) => void;
+  onSelectInterval?: (id: string) => void;
+}
+
+export declare const GlobalMegaMenu: React.FC<GlobalMegaMenuProps>;
+
+export interface FasterProLogoProps extends React.SVGProps<SVGSVGElement> {
+  className?: string;
+  isDarkMode?: boolean;
+  theme?: 'light' | 'dark' | 'system';
+}
+
+export declare const FasterProLogo: React.FC<FasterProLogoProps>;
+
+export declare const defaultHeaderConfig: HeaderConfig;
+export declare function createHeaderConfig(userConfig?: Partial<HeaderConfig>): HeaderConfig;
+export declare function renderIcon(IconOrNode: any, props?: any): React.ReactNode;
+export declare function buildItemUrl(options: {
+  baseUrl?: string;
+  route?: string;
+  href?: string;
+  queryParams?: Record<string, string | number | boolean | undefined>;
+  params?: Record<string, string | number | boolean | undefined>;
+  hash?: string;
+  currentTheme?: string;
+  appendTheme?: boolean;
+  themeParamName?: string;
+  isCurrentApp?: boolean;
+}): string;
+export declare function withThemeParam(url: string, currentTheme: string, themeParamName?: string): string;
+
+export declare const stockXRayCategories: any[];
+export declare const chartingCategories: any[];
+export declare const scannerCategories: any[];
+export declare const macroPulseCategories: any[];
+export declare const derivativesCategories: any[];
+
+export declare function cn(...inputs: any[]): string;