remoraid 2.2.5 → 2.5.6

package/dist/core/index.d.ts

@@ -1,9 +1,22 @@
-import { PropsWithChildren as PropsWithChildren4, ReactNode as ReactNode5 } from "react";
+import { PropsWithChildren as PropsWithChildren3, ReactNode as ReactNode4 } 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";
+type RemoraidUser = {
+	name: string
+} | null;
+interface RemoraidAppContext {
+	navigablePages: {
+		label: string
+		href: string
+		icon?: Icon
+	}[];
+	user?: RemoraidUser;
+}
+declare enum NavbarVariant {
+	Minimal = "minimal"
+}
 interface NavbarSettings {
 	hiddenPages: string[];
 	linkSize: string;
@@ -11,15 +24,40 @@ interface NavbarSettings {
 	py: MantineSize | number;
 	iconSize?: string | number;
 }
-interface UserExperience {
+type UserExperience = Record<string, any>;
+interface CoreUserExperience extends UserExperience {
 	navbarVariant: NavbarVariant;
 	navbarSettings: NavbarSettings;
 	showWelcomeMessage: boolean;
 }
-type AlertCategory = "negative" | "neutral" | "positive";
-type TransitionDuration = "short" | "medium" | "long";
-type RemoraidBreakpoint = "buttonCollapse" | "badgeGroupCollapse";
-type RemoraidIconSize = "tiny" | "medium";
+type UserExperienceProviderProps<T extends UserExperience> = {
+	initialValue?: Partial<T>
+	cookieName?: string
+};
+interface UserExperienceContext<T extends UserExperience> {
+	userExperience: T;
+	updateUserExperience: (p: T | ((prev: T) => T)) => void;
+	processedCookie: boolean;
+	initialUserExperience: T;
+}
+declare enum AlertCategory {
+	Negative = "negative",
+	Neutral = "neutral",
+	Positive = "positive"
+}
+declare enum TransitionDuration {
+	Short = "short",
+	Medium = "medium",
+	Long = "long"
+}
+declare enum RemoraidBreakpoint {
+	ButtonCollapse = "buttonCollapse",
+	BadgeGroupCollapse = "badgeGroupCollapse"
+}
+declare enum RemoraidIconSize {
+	Tiny = "tiny",
+	Medium = "medium"
+}
 interface RemoraidTheme {
 	complete: true;
 	transitionDurations: Record<TransitionDuration, number>;
@@ -36,14 +74,8 @@ interface RemoraidTheme {
 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;
+	settings?: Partial<NavbarSettings>;
 	variant?: NavbarVariant;
 	linkIndicator?: (isHovering: boolean) => IndicatorProps;
 	logoIndicator?: (isHovering: boolean) => IndicatorProps;
@@ -60,17 +92,12 @@ interface PageConfiguration {
 	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;
+interface SettingsTableOptions {
+	leftColumnWidth: string | number;
 }
-declare const userExperienceCookieName = "remoraid-user-experience";
-declare const useRemoraidUserExperience: () => UserExperienceContext;
-interface UserExperienceProviderProps {
-	initialValue?: Partial<UserExperience>;
+interface SettingsWidgetContext {
+	unsavedChanges?: boolean;
+	custom?: boolean;
 }
 interface WidgetsContext {
 	widgets: {
@@ -102,41 +129,62 @@ interface ThemeProviderProps {
 import { ReactCookieProps } from "react-cookie";
 interface RemoraidProviderProps {
 	theme?: RemoraidTheme | RemoraidThemeCallback | PartialRemoraidTheme;
-	initialUserExperience?: Partial<UserExperience>;
+	initialUserExperience?: Partial<CoreUserExperience>;
 	componentsProps?: {
 		ThemeProvider?: ThemeProviderProps
-		UserExperienceProvider?: UserExperienceProviderProps
+		CoreUserExperienceProvider?: UserExperienceProviderProps<CoreUserExperience>
 		WidgetsProvider?: WidgetsProviderProps
 		CookiesProvider?: ReactCookieProps
 	};
 }
-declare function RemoraidProvider({ children, theme, initialUserExperience, componentsProps }: PropsWithChildren4<RemoraidProviderProps>): ReactNode5;
-import { PropsWithChildren as PropsWithChildren5, ReactNode as ReactNode6 } from "react";
+declare function RemoraidProvider({ children, theme, initialUserExperience, componentsProps }: PropsWithChildren3<RemoraidProviderProps>): ReactNode4;
+import { PropsWithChildren as PropsWithChildren4, ReactNode as ReactNode5 } from "react";
 interface AppShellProps {
 	logo: AppShellLogo;
+	navigablePages: RemoraidAppContext["navigablePages"];
 	navbar: NavbarProps;
-	user?: {
-		name: string
-	} | null;
+	user?: RemoraidUser;
+}
+declare function AppShell({ children, logo, navbar, user, navigablePages }: PropsWithChildren4<AppShellProps>): ReactNode5;
+import { PropsWithChildren as PropsWithChildren5, ReactNode as ReactNode6 } from "react";
+declare const defaultAppContext: RemoraidAppContext;
+declare const useRemoraidApp: () => RemoraidAppContext;
+interface AppProviderProps {
+	navigablePages: RemoraidAppContext["navigablePages"];
+	user?: RemoraidUser;
+}
+declare function AppProvider({ children, navigablePages, user }: PropsWithChildren5<AppProviderProps>): ReactNode6;
+import { Context, PropsWithChildren as PropsWithChildren6, ReactNode as ReactNode7 } from "react";
+declare const createUserExperienceContext: <T extends UserExperience>(defaultUserExperience: T) => Context<UserExperienceContext<T>>;
+interface UserExperienceProviderWrapperProps<T extends UserExperience> {
+	context: Context<UserExperienceContext<T>>;
+	cookieName: string;
+	defaultUserExperience: T;
+	isValidUserExperience: (x: unknown) => x is T;
+	initialValue?: Partial<T>;
 }
-declare function AppShell({ children, logo, navbar, user }: PropsWithChildren5<AppShellProps>): ReactNode6;
+declare function UserExperienceProviderWrapper<T extends UserExperience>({ children, context, cookieName, defaultUserExperience, isValidUserExperience, initialValue }: PropsWithChildren6<UserExperienceProviderWrapperProps<T>>): ReactNode7;
+declare const defaultNavbarSettings: Record<NavbarVariant, NavbarSettings>;
+declare const defaultUserExperience: CoreUserExperience;
+declare const defaultUserExperienceCookieName = "remoraid-core-user-experience";
+declare const useRemoraidUserExperience: () => UserExperienceContext<CoreUserExperience>;
 import { MantineSize as MantineSize2 } from "@mantine/core";
-import { ReactNode as ReactNode7 } from "react";
+import { ReactNode as ReactNode9 } 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";
+declare function WidgetSelectionHeader({ title, disabledWidgets, mt }: WidgetSelectionHeaderProps): ReactNode9;
+import { ReactNode as ReactNode10 } from "react";
 interface CloseButtonProps {
 	widgetId: string;
 }
-declare function CloseButton({ widgetId }: CloseButtonProps): ReactNode8;
+declare function CloseButton2({ widgetId }: CloseButtonProps): ReactNode10;
 import { BadgeProps as BadgeProps2, MantineBreakpoint as MantineBreakpoint2, MantineSize as MantineSize3, TooltipProps as TooltipProps2 } from "@mantine/core";
-import { ReactNode as ReactNode10 } from "react";
+import { ReactNode as ReactNode12 } from "react";
 import { BadgeProps, TooltipProps, TransitionProps } from "@mantine/core";
-import { ReactNode as ReactNode9 } from "react";
+import { ReactNode as ReactNode11 } from "react";
 interface BadgeMinimalProps {
 	label: string;
 	tooltip?: string;
@@ -147,9 +195,9 @@ interface BadgeMinimalProps {
 		tooltip?: TooltipProps
 	};
 }
-declare function BadgeMinimal(props: BadgeMinimalProps): ReactNode9;
+declare function BadgeMinimal(props: BadgeMinimalProps): ReactNode11;
 interface BadgeGroupProps {
-	badges: (BadgeMinimalProps | ReactNode10)[];
+	badges: (BadgeMinimalProps | ReactNode12)[];
 	gap?: MantineSize3 | number;
 	breakpoint?: MantineBreakpoint2;
 	componentsProps?: {
@@ -157,9 +205,9 @@ interface BadgeGroupProps {
 		cumulativeBadge?: Partial<Omit<BadgeProps2, "hiddenFrom" | "circle">>
 	};
 }
-declare function BadgeGroup({ badges, gap, breakpoint, componentsProps }: BadgeGroupProps): ReactNode10;
+declare function BadgeGroup({ badges, gap, breakpoint, componentsProps }: BadgeGroupProps): ReactNode12;
 import { AlertProps as AlertProps2, MantineSize as MantineSize4, TransitionProps as TransitionProps2 } from "@mantine/core";
-import { PropsWithChildren as PropsWithChildren6, ReactNode as ReactNode11 } from "react";
+import { PropsWithChildren as PropsWithChildren8, ReactNode as ReactNode13 } from "react";
 interface AlertMinimalProps {
 	category: AlertCategory;
 	title?: string;
@@ -173,14 +221,19 @@ interface AlertMinimalProps {
 		transition?: Omit<TransitionProps2, "mounted">
 	};
 }
-declare function AlertMinimal({ children, title, category, text, onClose, mounted, mt, mb, componentsProps }: PropsWithChildren6<AlertMinimalProps>): ReactNode11;
+declare function AlertMinimal({ children, title, category, text, onClose, mounted, mt, mb, componentsProps }: PropsWithChildren8<AlertMinimalProps>): ReactNode13;
 import { ActionIconProps, ActionIconVariant, ButtonProps, ButtonVariant, MantineBreakpoint as MantineBreakpoint3, MantineColor, MantineSize as MantineSize5, TooltipProps as TooltipProps3 } from "@mantine/core";
 import { Icon as Icon2, IconProps as IconProps2 } from "@tabler/icons-react";
-import { ReactNode as ReactNode12 } from "react";
+import { ReactNode as ReactNode14 } from "react";
+import { ReactElement } from "react";
 type Common<
 	A,
 	B
 > = Pick<A & B, keyof A & keyof B>;
+type OnlyChildrenOf<
+	T extends (...args: any) => any,
+	P = any
+> = ReactElement<P, T> | ReactElement<P, T>[];
 interface RemoraidButtonProps {
 	label: string;
 	responsive?: boolean;
@@ -192,7 +245,7 @@ interface RemoraidButtonProps {
 	onClick?: () => void;
 	loading?: boolean;
 	variant?: Extract<ButtonVariant, ActionIconVariant>;
-	componentsProps: {
+	componentsProps?: {
 		tooltip?: Partial<TooltipProps3>
 		icon?: Partial<IconProps2>
 		button: Omit<Partial<Common<ButtonProps, ActionIconProps>>, "variant" | "onClick" | "size" | "color" | "loading">
@@ -200,9 +253,9 @@ interface RemoraidButtonProps {
 		ActionIcon?: Partial<ActionIconProps>
 	};
 }
-declare function RemoraidButton({ label, responsive, breakpoint, collapsed, size, color, onClick, loading, variant, componentsProps,...props }: RemoraidButtonProps): ReactNode12;
+declare function RemoraidButton({ label, responsive, breakpoint, collapsed, size, color, onClick, loading, variant, componentsProps,...props }: RemoraidButtonProps): ReactNode14;
 import { MantineSize as MantineSize6, PaperProps, TransitionProps as TransitionProps3 } from "@mantine/core";
-import { PropsWithChildren as PropsWithChildren7, ReactNode as ReactNode13 } from "react";
+import { PropsWithChildren as PropsWithChildren9, ReactNode as ReactNode15 } from "react";
 interface WidgetWrapperComponentsProps {
 	container?: Partial<PaperProps>;
 	transition?: Partial<Omit<TransitionProps3, "mounted">>;
@@ -213,9 +266,13 @@ interface WidgetWrapperProps {
 	withCloseButton?: boolean;
 	componentsProps?: WidgetWrapperComponentsProps;
 }
-declare function WidgetWrapper({ children, config, mt, withCloseButton, componentsProps }: PropsWithChildren7<WidgetWrapperProps>): ReactNode13;
+declare function WidgetWrapper({ children, config, mt, withCloseButton, componentsProps }: PropsWithChildren9<WidgetWrapperProps>): ReactNode15;
+interface WidgetWrapper extends React.FC<PropsWithChildren9<WidgetWrapperProps>> {
+	CloseButton: typeof CloseButton2;
+}
+declare const _default: WidgetWrapper;
 import { MantineSize as MantineSize7, LoaderProps } from "@mantine/core";
-import { PropsWithChildren as PropsWithChildren8, ReactNode as ReactNode14 } from "react";
+import { PropsWithChildren as PropsWithChildren10, ReactNode as ReactNode16 } from "react";
 interface WidgetComponentsProps extends WidgetWrapperComponentsProps {
 	wrapper?: Partial<Omit<WidgetWrapperProps, "widgetId">>;
 	loader?: Partial<LoaderProps>;
@@ -225,9 +282,9 @@ interface WidgetProps {
 	id: string;
 	title: string;
 	config?: Partial<Omit<WidgetConfiguration, "widgetId">>;
-	badges?: (BadgeMinimalProps | ReactNode14)[];
-	buttons?: (RemoraidButtonProps | ReactNode14)[];
-	alerts?: (AlertMinimalProps | ReactNode14)[];
+	badges?: (BadgeMinimalProps | ReactNode16)[];
+	buttons?: (RemoraidButtonProps | ReactNode16)[];
+	alerts?: (AlertMinimalProps | ReactNode16)[];
 	gaps?: MantineSize7 | number | {
 		badges?: MantineSize7 | number
 		buttons?: MantineSize7 | number
@@ -237,9 +294,9 @@ interface WidgetProps {
 	mt?: MantineSize7 | number;
 	componentsProps?: WidgetComponentsProps;
 }
-declare function Widget({ children, id, config, title, badges, buttons, alerts, gaps, loading, mt, componentsProps }: PropsWithChildren8<WidgetProps>): ReactNode14;
+declare function Widget({ children, id, config, title, badges, buttons, alerts, gaps, loading, mt, componentsProps }: PropsWithChildren10<WidgetProps>): ReactNode16;
 import { ContainerProps, MantineSize as MantineSize8 } from "@mantine/core";
-import { PropsWithChildren as PropsWithChildren9, ReactNode as ReactNode15 } from "react";
+import { PropsWithChildren as PropsWithChildren11, ReactNode as ReactNode17 } from "react";
 interface PageProps {
 	name?: string;
 	config?: Partial<Omit<PageConfiguration, "name">>;
@@ -248,27 +305,26 @@ interface PageProps {
 		container?: ContainerProps
 	};
 }
-declare function Page({ children, name, config, pt, componentsProps }: PropsWithChildren9<PageProps>): ReactNode15;
+declare function Page({ children, name, config, pt, componentsProps }: PropsWithChildren11<PageProps>): ReactNode17;
 import { ContainerProps as ContainerProps2, MantineSize as MantineSize9 } from "@mantine/core";
-import { PropsWithChildren as PropsWithChildren10, ReactNode as ReactNode16 } from "react";
+import { PropsWithChildren as PropsWithChildren12, ReactNode as ReactNode18 } from "react";
 interface PageContainerProps {
 	pt?: MantineSize9 | number;
 	componentsProps?: {
 		container?: ContainerProps2
 	};
 }
-declare function PageContainer({ children, pt, componentsProps }: PropsWithChildren10<PageContainerProps>): ReactNode16;
-import { PropsWithChildren as PropsWithChildren11, ReactNode as ReactNode17 } from "react";
-import { PageProps as PageProps2 } from "..";
+declare function PageContainer({ children, pt, componentsProps }: PropsWithChildren12<PageContainerProps>): ReactNode18;
+import { PropsWithChildren as PropsWithChildren13, ReactNode as ReactNode19 } from "react";
 interface NotFoundPageProps {
 	message?: string;
 	componentsProps?: {
-		page?: PageProps2
+		page?: PageProps
 	};
 }
-declare function NotFoundPage({ children, message, componentsProps }: PropsWithChildren11<NotFoundPageProps>): ReactNode17;
+declare function NotFoundPage({ children, message, componentsProps }: PropsWithChildren13<NotFoundPageProps>): ReactNode19;
 import { ContainerProps as ContainerProps3, MantineSize as MantineSize10 } from "@mantine/core";
-import { PropsWithChildren as PropsWithChildren12, ReactNode as ReactNode18 } from "react";
+import { PropsWithChildren as PropsWithChildren14, ReactNode as ReactNode20 } from "react";
 interface EnvironmentShellProps {
 	environment: Record<string, string | undefined>;
 	message?: string;
@@ -279,5 +335,59 @@ interface EnvironmentShellProps {
 		container?: ContainerProps3
 	};
 }
-declare function EnvironmentShell({ children, environment, message, m, mt, withContainer, componentsProps }: PropsWithChildren12<EnvironmentShellProps>): ReactNode18;
-export { userExperienceCookieName, useWidgets, useRemoraidUserExperience, useRemoraidTheme, defaultUserExperience, defaultNavbarSettings, createRemoraidTheme, WidgetsProviderProps, WidgetWrapperProps, WidgetWrapper, WidgetSelectionHeaderProps, WidgetSelectionHeader, WidgetProps, WidgetConfiguration, Widget, UserExperienceProviderProps, UserExperience, TransitionDuration, ThemeProviderProps, RemoraidThemeCallback, RemoraidTheme, RemoraidProviderProps, RemoraidProvider, RemoraidIconSize, RemoraidButtonProps, RemoraidButton, RemoraidBreakpoint, PartialRemoraidTheme, PageProps, PageContainerProps, PageContainer, PageConfiguration, Page, NotFoundPageProps, NotFoundPage, NavbarVariant, NavbarSettings, NavbarProps, NavbarLink, EnvironmentShellProps, EnvironmentShell, CloseButtonProps, CloseButton, BadgeMinimalProps, BadgeMinimal, BadgeGroupProps, BadgeGroup, AppShellProps, AppShellLogo, AppShell, AlertMinimalProps, AlertMinimal, AlertCategory };
+declare function EnvironmentShell({ children, environment, message, m, mt, withContainer, componentsProps }: PropsWithChildren14<EnvironmentShellProps>): ReactNode20;
+import { PropsWithChildren as PropsWithChildren15, ReactNode as ReactNode22 } from "react";
+import { ReactNode as ReactNode21 } from "react";
+import { GroupProps } from "@mantine/core";
+interface SettingsWidgetSaveButtonProps {
+	onSaveChanges: () => void;
+	insideContainer?: boolean;
+	componentsProps?: {
+		container?: Partial<GroupProps>
+		button?: Partial<RemoraidButtonProps>
+	};
+}
+declare function SaveButton2({ onSaveChanges, insideContainer, componentsProps }: SettingsWidgetSaveButtonProps): ReactNode21;
+declare const defaultSettingsWidgetContext: {};
+declare const useSettingsWidgetContext: () => SettingsWidgetContext;
+interface SettingsWidgetProps {
+	onRestoreDefaultValues?: () => void;
+	unsavedChanges?: boolean;
+	custom?: boolean;
+	widgetProps?: Partial<WidgetProps>;
+}
+declare function SettingsWidget({ children, onRestoreDefaultValues, unsavedChanges, custom, widgetProps }: PropsWithChildren15<SettingsWidgetProps>): ReactNode22;
+interface SettingsWidget extends React.FC<PropsWithChildren15<SettingsWidgetProps>> {
+	SaveButton: typeof SaveButton2;
+}
+declare const _default2: SettingsWidget;
+import { ReactNode as ReactNode24 } from "react";
+import { PropsWithChildren as PropsWithChildren16, ReactNode as ReactNode23 } from "react";
+interface SettingsTableRowProps {
+	label: string;
+}
+declare function Row2({ children, label }: PropsWithChildren16<SettingsTableRowProps>): ReactNode23;
+declare const defaultSettingsTableOptions: {
+	leftColumnWidth: string
+};
+declare const useSettingsTableOptions: () => SettingsTableOptions;
+interface SettingsTableProps {
+	children: OnlyChildrenOf<typeof Row2, SettingsTableRowProps>;
+	leftColumnWidth?: string | number;
+}
+declare function SettingsTable({ children, leftColumnWidth }: SettingsTableProps): ReactNode24;
+interface SettingsTable extends React.FC<SettingsTableProps> {
+	Row: typeof Row2;
+}
+declare const _default3: SettingsTable;
+import { ReactElement as ReactElement2, ReactNode as ReactNode25 } from "react";
+declare const defaultNavbarSettingsWidgetId = "navbar-settings";
+interface NavbarSettingsWidgetProps {
+	additionalRows?: ReactElement2<SettingsTableRowProps, typeof _default3.Row>[];
+	widgetProps?: Partial<WidgetProps>;
+	componentsProps?: {
+		table: Partial<Omit<SettingsTableProps, "children">>
+	};
+}
+declare function NavbarSettingsWidget({ additionalRows, widgetProps, componentsProps }: NavbarSettingsWidgetProps): ReactNode25;
+export { useWidgets, useSettingsWidgetContext as useSettingsWidgetOptions, useSettingsTableOptions, useRemoraidUserExperience, useRemoraidTheme, useRemoraidApp, defaultUserExperienceCookieName, defaultUserExperience, defaultSettingsWidgetContext as defaultSettingsWidgetOptions, defaultSettingsTableOptions, defaultNavbarSettingsWidgetId, defaultNavbarSettings, defaultAppContext, createUserExperienceContext, createRemoraidTheme, WidgetsProviderProps, WidgetWrapperProps, _default as WidgetWrapper, WidgetSelectionHeaderProps, WidgetSelectionHeader, WidgetProps, WidgetConfiguration, Widget, UserExperienceProviderWrapperProps, UserExperienceProviderWrapper, UserExperienceProviderProps, UserExperienceContext, UserExperience, TransitionDuration, ThemeProviderProps, SettingsWidgetSaveButtonProps, SettingsWidgetProps, SettingsWidgetContext, _default2 as SettingsWidget, SettingsTableRowProps, SettingsTableOptions, _default3 as SettingsTable, RemoraidUser, RemoraidThemeCallback, RemoraidTheme, RemoraidProviderProps, RemoraidProvider, RemoraidIconSize, RemoraidButtonProps, RemoraidButton, RemoraidBreakpoint, RemoraidAppContext, PartialRemoraidTheme, PageProps, PageContainerProps, PageContainer, PageConfiguration, Page, NotFoundPageProps, NotFoundPage, NavbarVariant, NavbarSettingsWidgetProps, NavbarSettingsWidget, NavbarSettings, NavbarProps, EnvironmentShellProps, EnvironmentShell, CoreUserExperience, CloseButtonProps, BadgeMinimalProps, BadgeMinimal, BadgeGroupProps, BadgeGroup, AppShellProps, AppShellLogo, AppShell, AppProvider, AlertMinimalProps, AlertMinimal, AlertCategory };