remoraid 1.1.0 → 2.0.0

package/dist/core/index.d.ts

@@ -0,0 +1,264 @@
+import { PropsWithChildren as PropsWithChildren4, ReactNode as ReactNode5 } from "react";
+import { AlertProps, IndicatorProps, MantineBreakpoint, MantineColorScheme, MantineSize, MantineTheme, ScrollAreaProps } from "@mantine/core";
+import { Icon, IconProps } from "@tabler/icons-react";
+import { ImageProps } from "next/image";
+import { ReactNode } from "react";
+type NavbarVariant = "minimal";
+interface NavbarSettings {
+	hiddenPages: string[];
+	linkSize: string;
+	px: MantineSize | number;
+	py: MantineSize | number;
+	iconSize?: string | number;
+}
+interface UserExperience {
+	navbarVariant: NavbarVariant;
+	navbarSettings: NavbarSettings;
+	showWelcomeMessage: boolean;
+}
+type AlertCategory = "negative" | "neutral" | "positive";
+interface RemoraidTheme {
+	complete: true;
+	transitionDurations: {
+		short: number
+		medium: number
+		long: number
+	};
+	breakpoints: {
+		buttonCollapse: MantineBreakpoint
+		badgeGroupCollapse: MantineBreakpoint
+	};
+	scrollAreaProps: ScrollAreaProps;
+	alertProps: { [C in AlertCategory] : AlertProps };
+	containerSize: MantineSize | number;
+	iconProps: {
+		tiny: IconProps
+		medium: IconProps
+	};
+	transparentBackground?: string;
+	primaryColor?: string;
+	spacingPx?: { [S in MantineSize] : number };
+}
+type RemoraidThemeCallback = (mantineTheme: MantineTheme, colorScheme: MantineColorScheme) => RemoraidTheme;
+type PartialRemoraidTheme = Omit<Partial<RemoraidTheme>, "complete">;
+type AppShellLogo = (props: Omit<ImageProps, "src" | "alt">) => ReactNode;
+interface NavbarLink {
+	icon: Icon;
+	label: string;
+	href: string;
+}
+interface NavbarProps {
+	links: NavbarLink[];
+	settings?: NavbarSettings;
+	variant?: NavbarVariant;
+	linkIndicator?: (isHovering: boolean) => IndicatorProps;
+	logoIndicator?: (isHovering: boolean) => IndicatorProps;
+	onLogout?: () => void;
+}
+interface WidgetConfiguration {
+	widgetId: string;
+	name: string;
+	initialValue?: boolean;
+	allowUnregisteredPageUsage?: boolean;
+}
+interface PageConfiguration {
+	pageId: string;
+	name: string;
+	registerPageDirectly?: boolean;
+}
+declare const defaultNavbarSettings: { [V in NavbarVariant] : NavbarSettings };
+declare const defaultUserExperience: UserExperience;
+interface UserExperienceContext {
+	userExperience: UserExperience;
+	updateUserExperience: (p: UserExperience | ((prev: UserExperience) => UserExperience)) => void;
+	processedCookie: boolean;
+}
+declare const userExperienceCookieName = "remoraid-user-experience";
+declare const useRemoraidUserExperience: () => UserExperienceContext;
+interface UserExperienceProviderProps {
+	initialValue?: Partial<UserExperience>;
+}
+interface WidgetsContext {
+	widgets: {
+		[index: string]: {
+			[index: string]: {
+				name: string
+				selected: boolean
+			}
+		}
+	};
+	activeWidget: string | null;
+	updateActiveWidget: (widgetId: string | null) => void;
+	registerWidget: (pageId: string, widget: WidgetConfiguration) => void;
+	registerPage: (pageId: string, initialWidgets: WidgetConfiguration[]) => void;
+	isWidgetRegistered: (pageId: string, widgetId: string) => boolean;
+	isPageRegistered: (pageId: string) => boolean;
+	updateWidgetSelection: (pageId: string, widgetId: string, value: boolean) => void;
+	updateWidgetSelectionBulk: (pageId: string, selectedWidgetIds: string[]) => void;
+	isWidgetSelected: (pageId: string, widgetId: string) => boolean;
+}
+declare const useWidgets: () => WidgetsContext;
+interface WidgetsProviderProps {}
+import { MantineColorScheme as MantineColorScheme2, MantineTheme as MantineTheme2 } from "@mantine/core";
+declare const createRemoraidTheme: (customTheme?: Partial<RemoraidTheme>, mantineTheme?: MantineTheme2, colorScheme?: MantineColorScheme2) => RemoraidTheme;
+declare const useRemoraidTheme: () => RemoraidTheme;
+interface ThemeProviderProps {
+	theme?: RemoraidTheme | RemoraidThemeCallback | PartialRemoraidTheme;
+}
+import { ReactCookieProps } from "react-cookie";
+interface RemoraidProviderProps {
+	theme?: RemoraidTheme | RemoraidThemeCallback | PartialRemoraidTheme;
+	initialUserExperience?: Partial<UserExperience>;
+	componentsProps?: {
+		ThemeProvider?: ThemeProviderProps
+		UserExperienceProvider?: UserExperienceProviderProps
+		WidgetsProvider?: WidgetsProviderProps
+		CookiesProvider?: ReactCookieProps
+	};
+}
+declare function RemoraidProvider({ children, theme, initialUserExperience, componentsProps }: PropsWithChildren4<RemoraidProviderProps>): ReactNode5;
+import { PropsWithChildren as PropsWithChildren5, ReactNode as ReactNode6 } from "react";
+interface AppShellProps {
+	logo: AppShellLogo;
+	navbar: NavbarProps;
+	user?: {
+		name: string
+	} | null;
+}
+declare function AppShell({ children, logo, navbar, user }: PropsWithChildren5<AppShellProps>): ReactNode6;
+import { MantineSize as MantineSize2 } from "@mantine/core";
+import { ReactNode as ReactNode7 } from "react";
+interface WidgetSelectionHeaderProps {
+	title?: string;
+	disabledWidgets?: string[];
+	mt?: MantineSize2 | number;
+}
+declare function WidgetSelectionHeader({ title, disabledWidgets, mt }: WidgetSelectionHeaderProps): ReactNode7;
+import { ReactNode as ReactNode8 } from "react";
+interface CloseButtonProps {
+	widgetId: string;
+}
+declare function CloseButton({ widgetId }: CloseButtonProps): ReactNode8;
+import { BadgeProps as BadgeProps2, MantineBreakpoint as MantineBreakpoint2, MantineSize as MantineSize3, TooltipProps as TooltipProps2 } from "@mantine/core";
+import { ReactNode as ReactNode10 } from "react";
+import { BadgeProps, TooltipProps, TransitionProps } from "@mantine/core";
+import { ReactNode as ReactNode9 } from "react";
+interface BadgeMinimalProps {
+	label: string;
+	tooltip?: string;
+	mounted?: boolean;
+	componentsProps?: {
+		badge?: BadgeProps
+		transition?: Partial<Omit<TransitionProps, "mounted">>
+		tooltip?: TooltipProps
+	};
+}
+declare function BadgeMinimal(props: BadgeMinimalProps): ReactNode9;
+interface BadgeGroupProps {
+	badges: (BadgeMinimalProps | ReactNode10)[];
+	gap?: MantineSize3 | number;
+	breakpoint?: MantineBreakpoint2;
+	componentsProps?: {
+		tooltip?: Partial<TooltipProps2>
+		cumulativeBadge?: Partial<Omit<BadgeProps2, "hiddenFrom" | "circle">>
+	};
+}
+declare function BadgeGroup({ badges, gap, breakpoint, componentsProps }: BadgeGroupProps): ReactNode10;
+import { AlertProps as AlertProps2, MantineSize as MantineSize4, TransitionProps as TransitionProps2 } from "@mantine/core";
+import { PropsWithChildren as PropsWithChildren6, ReactNode as ReactNode11 } from "react";
+interface AlertMinimalProps {
+	category: AlertCategory;
+	title?: string;
+	text?: string;
+	onClose?: () => void;
+	mounted?: boolean;
+	mt?: MantineSize4 | number;
+	mb?: MantineSize4 | number;
+	componentsProps?: {
+		alert?: AlertProps2
+		transition?: Omit<TransitionProps2, "mounted">
+	};
+}
+declare function AlertMinimal({ children, title, category, text, onClose, mounted, mt, mb, componentsProps }: PropsWithChildren6<AlertMinimalProps>): ReactNode11;
+import { ActionIconVariant, ButtonVariant, MantineBreakpoint as MantineBreakpoint3, TooltipProps as TooltipProps3 } from "@mantine/core";
+import { Icon as Icon2 } from "@tabler/icons-react";
+import { ReactNode as ReactNode12 } from "react";
+interface ResponsiveButtonProps {
+	label: string;
+	icon?: Icon2;
+	onClick?: () => void;
+	breakpoint?: MantineBreakpoint3;
+	loading?: boolean;
+	variant?: Extract<ButtonVariant, ActionIconVariant>;
+	componentsProps?: {
+		tooltip?: Partial<TooltipProps3>
+	};
+}
+declare function ResponsiveButton(props: ResponsiveButtonProps): ReactNode12;
+import { MantineSize as MantineSize5, PaperProps, TransitionProps as TransitionProps3 } from "@mantine/core";
+import { PropsWithChildren as PropsWithChildren7, ReactNode as ReactNode13 } from "react";
+interface WidgetWrapperComponentsProps {
+	container?: Partial<PaperProps>;
+	transition?: Partial<Omit<TransitionProps3, "mounted">>;
+}
+interface WidgetWrapperProps {
+	config: WidgetConfiguration;
+	mt?: MantineSize5 | number;
+	withCloseButton?: boolean;
+	componentsProps?: WidgetWrapperComponentsProps;
+}
+declare function WidgetWrapper({ children, config, mt, withCloseButton, componentsProps }: PropsWithChildren7<WidgetWrapperProps>): ReactNode13;
+import { MantineSize as MantineSize6, LoaderProps } from "@mantine/core";
+import { PropsWithChildren as PropsWithChildren8, ReactNode as ReactNode14 } from "react";
+interface WidgetComponentsProps extends WidgetWrapperComponentsProps {
+	wrapper?: Partial<Omit<WidgetWrapperProps, "widgetId">>;
+	loader?: Partial<LoaderProps>;
+	badgeGroup?: Partial<BadgeGroupProps>;
+}
+interface WidgetProps {
+	id: string;
+	title: string;
+	config?: Partial<Omit<WidgetConfiguration, "widgetId">>;
+	badges?: (BadgeMinimalProps | ReactNode14)[];
+	buttons?: (ResponsiveButtonProps | ReactNode14)[];
+	alerts?: (AlertMinimalProps | ReactNode14)[];
+	gaps?: MantineSize6 | number | {
+		badges?: MantineSize6 | number
+		buttons?: MantineSize6 | number
+		alerts?: MantineSize6 | number
+	};
+	loading?: boolean;
+	mt?: MantineSize6 | number;
+	componentsProps?: WidgetComponentsProps;
+}
+declare function Widget({ children, id, config, title, badges, buttons, alerts, gaps, loading, mt, componentsProps }: PropsWithChildren8<WidgetProps>): ReactNode14;
+import { ContainerProps, MantineSize as MantineSize7 } from "@mantine/core";
+import { PropsWithChildren as PropsWithChildren9, ReactNode as ReactNode15 } from "react";
+interface PageProps {
+	name?: string;
+	config?: Partial<Omit<PageConfiguration, "name">>;
+	pt?: MantineSize7 | number;
+	componentsProps?: {
+		container?: ContainerProps
+	};
+}
+declare function Page({ children, name, config, pt, componentsProps }: PropsWithChildren9<PageProps>): ReactNode15;
+import { PropsWithChildren as PropsWithChildren10, ReactNode as ReactNode16 } from "react";
+import { PageProps as PageProps2 } from "..";
+interface NotFoundPageProps {
+	message?: string;
+	componentsProps?: {
+		page?: PageProps2
+	};
+}
+declare function NotFoundPage({ children, message, componentsProps }: PropsWithChildren10<NotFoundPageProps>): ReactNode16;
+import { MantineSize as MantineSize8 } from "@mantine/core";
+import { PropsWithChildren as PropsWithChildren11, ReactNode as ReactNode17 } from "react";
+interface EnvironmentShellProps {
+	vars: string[];
+	message?: string;
+	m?: MantineSize8 | number;
+	mt?: MantineSize8 | number;
+}
+declare function EnvironmentShell({ children, vars, message, m, mt }: PropsWithChildren11<EnvironmentShellProps>): ReactNode17;
+export { userExperienceCookieName, useWidgets, useRemoraidUserExperience, useRemoraidTheme, defaultUserExperience, defaultNavbarSettings, createRemoraidTheme, WidgetWrapper, WidgetSelectionHeader, Widget, ResponsiveButton, RemoraidProvider, Page, NotFoundPage, EnvironmentShell, CloseButton, BadgeMinimal, BadgeGroup, AppShell, AlertMinimal };