remoraid 3.1.1 → 3.5.0

package/dist/core/index.d.ts

@@ -1,5 +1,5 @@
 import { PropsWithChildren as PropsWithChildren7, ReactNode as ReactNode7 } from "react";
-import { MantineBreakpoint, MantineColorScheme, MantineSize, MantineTheme } from "@mantine/core";
+import { MantineBreakpoint, MantineColorScheme, MantineSize, MantineTheme, ScrollerProps } from "@mantine/core";
 import { Icon as Icon2, IconProps as IconProps2 } from "@tabler/icons-react";
 import React2, { Dispatch, MouseEventHandler, ReactElement, SetStateAction } from "react";
 import { PartialDeep } from "type-fest";
@@ -30,10 +30,12 @@ interface RemoraidAuthContext {
 	onLogout?: () => void;
 }
 declare enum NavbarVariant {
-	Minimal = "minimal"
+	Minimal = "minimal",
+	Custom = "custom"
 }
 declare enum FooterVariant {
-	Minimal = "minimal"
+	Minimal = "minimal",
+	Custom = "custom"
 }
 declare enum NavbarMode {
 	Responsive = "responsive",
@@ -62,18 +64,36 @@ interface NavigationElementButton extends NavigationElementBase {
 }
 type NavigationElement = NavigationElementButton | NavigationElementAnchor;
 type NavbarMobileVariant = null;
-type AppShellFooterVariant = FooterVariant | null;
-type AppShellNavbarVariant = NavbarVariant | null;
 type AppShellNavbarMobileVariant = NavbarMobileVariant | null;
-interface StaticRemoraidAppContext {
+interface NavbarMetadata {
+	defaultPosition: NavbarPosition;
+	supportedModes: NavbarMode[];
+	supportedPositions: NavbarPosition[];
+}
+interface FooterMetadata {
+	defaultPosition: FooterPosition;
+	supportedPositions: FooterPosition[];
+}
+interface StaticRemoraidAppContextBase {
 	name: string;
 	nav: NavigationElement[];
-	navbarVariant: AppShellNavbarVariant;
 	navbarMobileVariant: AppShellNavbarMobileVariant;
-	footerVariant: AppShellFooterVariant;
 	logo?: Icon2 | ReactElement;
 	auth?: RemoraidAuthContext;
 }
+type StaticRemoraidAppContext = StaticRemoraidAppContextBase & ({
+	navbarVariant: null
+	navbarMetadata?: never
+} | {
+	navbarVariant: NavbarVariant
+	navbarMetadata: NavbarMetadata
+}) & ({
+	footerVariant: null
+	footerMetadata?: never
+} | {
+	footerVariant: FooterVariant
+	footerMetadata: FooterMetadata
+});
 type CustomAppVariables = { [K in Exclude<string, keyof StaticRemoraidAppContext>] : any };
 type RemoraidAppContext<V extends CustomAppVariables> = StaticRemoraidAppContext & V;
 declare enum NavbarOrientation {
@@ -168,8 +188,9 @@ interface RemoraidTheme {
 	transparentBackground?: string;
 	spacingPx?: Record<MantineSize, number>;
 	componentsProps: {
-		icons: Record<RemoraidIconSize, Partial<IconProps2>>
+		icons: Record<RemoraidIconSize, Partial<IconProps2> & Required<Pick<IconProps2, "size" | "stroke">>>
 		alerts: Record<AlertCategory, Omit<Partial<AlertMinimalProps>, "category">>
+		Scroller: Partial<ScrollerProps>
 	};
 }
 interface RemoraidThemeDependencies {
@@ -297,11 +318,24 @@ declare function RemoraidProvider({ children, theme, initialUserExperience, rout
 import { BoxProps as BoxProps3 } from "@mantine/core";
 import { ComponentProps as ComponentProps7, PropsWithChildren as PropsWithChildren13, ReactNode as ReactNode22 } from "react";
 import { PropsWithChildren as PropsWithChildren8, ReactNode as ReactNode8 } from "react";
-import { SetOptional } from "type-fest";
 declare const defaultAppContext: RemoraidAppContext<CustomAppVariables>;
 declare const useRemoraidApp: () => RemoraidAppContext<CustomAppVariables>;
 interface AppProviderProps<V extends CustomAppVariables> {
-	appContext: SetOptional<RemoraidAppContext<V>, "navbarVariant" | "footerVariant" | "navbarMobileVariant">;
+	appContext: Omit<RemoraidAppContext<V>, "navbarVariant" | "navbarMetadata" | "footerVariant" | "footerMetadata" | "navbarMobileVariant"> & ({
+		navbarVariant?: Exclude<NavbarVariant | null, NavbarVariant.Custom>
+		navbarMetadata?: never
+	} | {
+		navbarVariant: NavbarVariant.Custom
+		navbarMetadata: NavbarMetadata
+	}) & ({
+		footerVariant?: Exclude<FooterVariant | null, FooterVariant.Custom>
+		footerMetadata?: never
+	} | {
+		footerVariant: FooterVariant.Custom
+		footerMetadata: FooterMetadata
+	}) & {
+		navbarMobileVariant?: AppShellNavbarMobileVariant
+	};
 }
 declare function AppProvider2<V extends CustomAppVariables>({ appContext: appContextProp, children }: PropsWithChildren8<AppProviderProps<V>>): ReactNode8;
 import { ComponentProps as ComponentProps4, ReactNode as ReactNode18 } from "react";
@@ -367,6 +401,8 @@ declare const asElementOrPropsOfType: <
 declare const getDefaultButtonIconSize: (buttonSize: MantineSize2) => RemoraidIconSize;
 declare const scrollToWidget: (widgetId: string) => void;
 declare const isIcon: (value: unknown) => value is Icon3;
+declare const navbarMetadata: Record<Exclude<NavbarVariant, NavbarVariant.Custom>, NavbarMetadata>;
+declare const footerMetadata: Record<Exclude<FooterVariant, FooterVariant.Custom>, FooterMetadata>;
 declare const defaultRemoraidButtonSize = "sm";
 type RemoraidButtonDefaultResponsivity = true;
 interface ExplicitRemoraidButtonProps<Responsive extends boolean> {
@@ -398,6 +434,7 @@ interface NavbarMinimalContentProps {
 	orientation: NavbarOrientation;
 	maxElements?: number;
 	collapseStaticElementsBreakpoint?: MantineBreakpoint3;
+	includeDefaultNavigationElements?: boolean;
 	componentsProps?: {
 		container?: Partial<PaperProps>
 		button?: Partial<RemoraidButtonProps<true>> | Partial<RemoraidButtonProps<false>>
@@ -490,6 +527,7 @@ type PinnableProps<T extends LayoutType = PinnableDefaultLayoutType> = OptionalI
 declare function Pinnable2<T extends LayoutType = PinnableDefaultLayoutType>({ layoutType: layoutTypeProp, section, initialValue, layoutId, controlsContainer, hidden, onPinnedValueChange, componentsProps, children }: PropsWithChildren11<PinnableProps<T>>): ReactNode16;
 interface NavbarMinimalProps {
 	pinnable?: boolean;
+	includeDefaultNavigationElements?: boolean;
 	componentsProps?: {
 		container?: Partial<PageContainerProps>
 		content?: Partial<NavbarMinimalContentProps>
@@ -497,9 +535,7 @@ interface NavbarMinimalProps {
 		Pinnable?: Partial<PinnableProps>
 	};
 }
-declare function NavbarMinimal({ pinnable, componentsProps }: NavbarMinimalProps): ReactNode17;
-declare const supportedNavbarPositions: Record<Exclude<AppShellNavbarVariant, null>, NavbarPosition[]>;
-declare const defaultNavbarPositions: Record<Exclude<AppShellNavbarVariant, null>, NavbarPosition>;
+declare function NavbarMinimal({ pinnable, includeDefaultNavigationElements, componentsProps }: NavbarMinimalProps): ReactNode17;
 declare const getDefaultNavigationElements: ({ colorScheme, setColorScheme, auth }: Partial<DefaultNavigationElementsDependencies>) => NavigationElement[];
 interface NavbarProps {
 	componentsProps?: {
@@ -523,8 +559,6 @@ interface FooterMinimalProps {
 	};
 }
 declare function FooterMinimal({ icon: Icon6, componentsProps }: FooterMinimalProps): ReactNode19;
-declare const supportedFooterPositions: Record<Exclude<AppShellFooterVariant, null>, FooterPosition[]>;
-declare const defaultFooterPositions: Record<Exclude<AppShellFooterVariant, null>, FooterPosition>;
 interface FooterProps {
 	componentsProps?: {
 		FooterMinimal?: Partial<FooterMinimalProps>
@@ -600,20 +634,19 @@ declare const defaultUserExperienceCookieName = "remoraid-core-user-experience";
 declare const useRemoraidUserExperience: () => UserExperienceContext<CoreUserExperience>;
 import { ChipProps, DividerProps, FlexProps as FlexProps2, MenuProps as MenuProps2, TextProps } from "@mantine/core";
 import { ReactNode as ReactNode27 } from "react";
-import { ChipGroupProps, FlexProps, MantineSize as MantineSize7, ScrollAreaProps as ScrollAreaProps2 } from "@mantine/core";
-import { PropsWithChildren as PropsWithChildren17, ReactNode as ReactNode26, RefObject as RefObject2 } from "react";
+import { ChipGroupProps, FlexProps, MantineSize as MantineSize7, ScrollerProps as ScrollerProps2 } from "@mantine/core";
+import { PropsWithChildren as PropsWithChildren17, ReactNode as ReactNode26 } from "react";
 interface ScrollableChipGroupProps {
 	value: string[];
-	ref?: RefObject2<HTMLDivElement | null>;
 	onChange?: (value: string[]) => void;
 	gap?: MantineSize7 | number;
 	componentsProps?: {
-		chipGroup?: Partial<ChipGroupProps<true>>
 		container?: Partial<FlexProps>
-		ScrollArea?: Partial<ScrollAreaProps2>
+		ChipGroup?: Partial<ChipGroupProps<true>>
+		Scroller?: Partial<ScrollerProps2>
 	};
 }
-declare function ScrollableChipGroup2({ value, ref, onChange, gap, componentsProps, children }: PropsWithChildren17<ScrollableChipGroupProps>): ReactNode26;
+declare function ScrollableChipGroup2({ value, onChange, gap, componentsProps, children }: PropsWithChildren17<ScrollableChipGroupProps>): ReactNode26;
 interface WidgetSelectionHeaderProps {
 	title?: string;
 	pinnableSection?: FrameLayoutSection.Top | FrameLayoutSection.Bottom | null;
@@ -629,7 +662,7 @@ interface WidgetSelectionHeaderProps {
 		Pinnable?: Partial<PinnableProps>
 	};
 }
-declare function WidgetSelectionHeader({ title, pinnableSection, initiallyPinned, disabledWidgets, componentsProps }: WidgetSelectionHeaderProps): ReactNode27;
+declare function WidgetSelectionHeader({ title, pinnableSection, initiallyPinned: initiallyPinnedProp, disabledWidgets, componentsProps }: WidgetSelectionHeaderProps): ReactNode27;
 import { BadgeProps as BadgeProps2, GroupProps as GroupProps3, HoverCardProps, MantineBreakpoint as MantineBreakpoint4, MantineSize as MantineSize8, StackProps as StackProps2, TransitionProps as TransitionProps7 } from "@mantine/core";
 import { ReactNode as ReactNode29 } from "react";
 import { BadgeProps, TooltipProps as TooltipProps3, TransitionProps as TransitionProps6 } from "@mantine/core";
@@ -823,7 +856,7 @@ declare function ContextClusterProvider<
 	Context,
 	StaticID extends string = never
 >({ cluster, values, children }: PropsWithChildren25<ContextClusterProviderProps<Context, StaticID>>): ReactNode41;
-import { BoxProps as BoxProps4, InputWrapperProps, ScrollAreaProps as ScrollAreaProps3 } from "@mantine/core";
+import { BoxProps as BoxProps4, InputWrapperProps, ScrollAreaProps as ScrollAreaProps2 } from "@mantine/core";
 import { PropsWithChildren as PropsWithChildren26, ReactNode as ReactNode42 } from "react";
 interface InputWrapperScrollAreaProps {
 	label?: string;
@@ -833,9 +866,9 @@ interface InputWrapperScrollAreaProps {
 	required?: boolean;
 	componentsProps?: {
 		container?: Partial<InputWrapperProps>
-		ScrollArea?: Partial<ScrollAreaProps3>
+		ScrollArea?: Partial<ScrollAreaProps2>
 		childrenContainer?: Partial<BoxProps4>
 	};
 }
 declare function InputWrapperScrollArea({ children, label, mah, description, error, required, componentsProps }: PropsWithChildren26<InputWrapperScrollAreaProps>): ReactNode42;
-export { useWidgets, useWidget, useSettingsWidgetContext as useSettingsWidgetOptions, useSettingsTableOptions, useRemoraidUserExperience, useRemoraidTheme, useRemoraidRouter, useRemoraidApp, usePage, useLayouts, useHydrationStatus, useHydratedMantineColorScheme, useFrameLayoutElement, useFrameLayout, useAppShellUserExperience, supportedNavbarPositions, supportedFooterPositions, scrollToWidget, remoraidAppShellLayoutId, isValidElementOfType, isIcon, getElementTypeName, getDefaultWidgetContext, getDefaultNavigationElements, getDefaultButtonIconSize, getCssVars, defaultUserExperienceCookieName, defaultUserExperience, defaultTransitionDurations, defaultSettingsWidgetContext as defaultSettingsWidgetOptions, defaultSettingsTableOptions, defaultRemoraidButtonSize, defaultNavbarSettingsWidgetId, defaultNavbarPositions, defaultLayoutsContext, defaultFooterSettingsWidgetId, defaultFooterPositions, defaultAppShellUserExperienceCookieName, defaultAppShellUserExperience, defaultAppContext, createUserExperienceContext, createRemoraidTheme, createContextCluster, co, asElementOrPropsOfType, asElementOfType, asChildrenOfType, WidgetsProviderProps, WidgetsContext, WidgetWrapperProps, WidgetWrapper, WidgetSelectionHeaderProps, WidgetSelectionHeader, WidgetProps, WidgetContext, WidgetConfiguration, Widget, UserExperienceProviderWrapperProps, UserExperienceProviderWrapper, UserExperienceProviderProps, UserExperienceContext, UserExperience, TransitionDuration, ThemeProviderProps, StaticRemoraidAppContext, SettingsWidgetSaveButtonProps, SettingsWidgetProps, SettingsWidgetContext, _default5 as SettingsWidget, SettingsTableRowProps, SettingsTableOptions, _default6 as SettingsTable, ScrollableChipGroupProps, ScrollableChipGroup2 as ScrollableChipGroup, RouterProviderProps, RouterProvider2 as RouterProvider, RouterAdapter, RemoraidUser, RemoraidThemeDependencies, RemoraidThemeCallback, RemoraidTheme, RemoraidProviderProps, RemoraidProvider, RemoraidIconSize, RemoraidButtonProps, RemoraidButtonDefaultResponsivity, RemoraidButton, RemoraidBreakpoint, RemoraidAuthContext, RemoraidAppContext, PropsWithChildrenOfType, PrimitiveUserExperience, PinnableProps, PinnableDefaultLayoutType, Pinnable2 as Pinnable, PageProps, PageContainerProps, PageContainer2 as PageContainer, PageConfiguration, Page, OptionalIfExtends, Optional, NotFoundPageProps, NotFoundPage, NavigationMenuProps, NavigationElementType, NavigationElementButton, NavigationElementBase, NavigationElementAnchor, NavigationElement, NavbarVariant, NavbarSettingsWidgetProps, NavbarSettingsWidget, NavbarProps, NavbarPosition, NavbarOrientation, NavbarMode, NavbarMobileVariant, NavbarMobilePosition, NavbarMinimalProps, NavbarMinimalContentProps, _default as Navbar, LayoutsProviderProps, LayoutsContext, LayoutType, LayoutSection, LayoutElementContext, LayoutContext, InputWrapperScrollAreaProps, InputWrapperScrollArea, HydrationStatusProviderProps, HydrationStatusProvider, HydrationStatus, FrameLayoutSection, FrameLayoutProps, FrameLayoutElementProps, _default3 as FrameLayout, FooterVariant, FooterSettingsWidgetProps, FooterSettingsWidget, FooterProps, FooterPosition, FooterMinimalProps, _default2 as Footer, EnvironmentShellVariant, EnvironmentShellProps, EnvironmentShell, ElementOrPropsOfType, ElementOfType, DefaultNavigationElementsDependencies, CustomAppVariables, CoreUserExperience, ControlsProps, Controls, ControlButtonProps, ControlButton, ContextClusterProviderProps, ContextClusterProvider, ContextCluster, Common, ClickTransformation, ChildrenOfType, BadgeMinimalProps, BadgeMinimal, BadgeGroupProps, BadgeGroup, AppShellUserExperience, AppShellProps, AppShellNavbarVariant, AppShellNavbarMobileVariant, AppShellFooterVariant, _default4 as AppShell, AppProviderProps, AppProvider2 as AppProvider, AlertMinimalProps, AlertMinimal, AlertCategory };
+export { useWidgets, useWidget, useSettingsWidgetContext as useSettingsWidgetOptions, useSettingsTableOptions, useRemoraidUserExperience, useRemoraidTheme, useRemoraidRouter, useRemoraidApp, usePage, useLayouts, useHydrationStatus, useHydratedMantineColorScheme, useFrameLayoutElement, useFrameLayout, useAppShellUserExperience, scrollToWidget, remoraidAppShellLayoutId, navbarMetadata, isValidElementOfType, isIcon, getElementTypeName, getDefaultWidgetContext, getDefaultNavigationElements, getDefaultButtonIconSize, getCssVars, footerMetadata, defaultUserExperienceCookieName, defaultUserExperience, defaultTransitionDurations, defaultSettingsWidgetContext as defaultSettingsWidgetOptions, defaultSettingsTableOptions, defaultRemoraidButtonSize, defaultNavbarSettingsWidgetId, defaultLayoutsContext, defaultFooterSettingsWidgetId, defaultAppShellUserExperienceCookieName, defaultAppShellUserExperience, defaultAppContext, createUserExperienceContext, createRemoraidTheme, createContextCluster, co, asElementOrPropsOfType, asElementOfType, asChildrenOfType, WidgetsProviderProps, WidgetsContext, WidgetWrapperProps, WidgetWrapper, WidgetSelectionHeaderProps, WidgetSelectionHeader, WidgetProps, WidgetContext, WidgetConfiguration, Widget, UserExperienceProviderWrapperProps, UserExperienceProviderWrapper, UserExperienceProviderProps, UserExperienceContext, UserExperience, TransitionDuration, ThemeProviderProps, StaticRemoraidAppContext, SettingsWidgetSaveButtonProps, SettingsWidgetProps, SettingsWidgetContext, _default5 as SettingsWidget, SettingsTableRowProps, SettingsTableOptions, _default6 as SettingsTable, ScrollableChipGroupProps, ScrollableChipGroup2 as ScrollableChipGroup, RouterProviderProps, RouterProvider2 as RouterProvider, RouterAdapter, RemoraidUser, RemoraidThemeDependencies, RemoraidThemeCallback, RemoraidTheme, RemoraidProviderProps, RemoraidProvider, RemoraidIconSize, RemoraidButtonProps, RemoraidButtonDefaultResponsivity, RemoraidButton, RemoraidBreakpoint, RemoraidAuthContext, RemoraidAppContext, PropsWithChildrenOfType, PrimitiveUserExperience, PinnableProps, PinnableDefaultLayoutType, Pinnable2 as Pinnable, PageProps, PageContainerProps, PageContainer2 as PageContainer, PageConfiguration, Page, OptionalIfExtends, Optional, NotFoundPageProps, NotFoundPage, NavigationMenuProps, NavigationElementType, NavigationElementButton, NavigationElementBase, NavigationElementAnchor, NavigationElement, NavbarVariant, NavbarSettingsWidgetProps, NavbarSettingsWidget, NavbarProps, NavbarPosition, NavbarOrientation, NavbarMode, NavbarMobileVariant, NavbarMobilePosition, NavbarMinimalProps, NavbarMinimalContentProps, NavbarMetadata, _default as Navbar, LayoutsProviderProps, LayoutsContext, LayoutType, LayoutSection, LayoutElementContext, LayoutContext, InputWrapperScrollAreaProps, InputWrapperScrollArea, HydrationStatusProviderProps, HydrationStatusProvider, HydrationStatus, FrameLayoutSection, FrameLayoutProps, FrameLayoutElementProps, _default3 as FrameLayout, FooterVariant, FooterSettingsWidgetProps, FooterSettingsWidget, FooterProps, FooterPosition, FooterMinimalProps, FooterMetadata, _default2 as Footer, EnvironmentShellVariant, EnvironmentShellProps, EnvironmentShell, ElementOrPropsOfType, ElementOfType, DefaultNavigationElementsDependencies, CustomAppVariables, CoreUserExperience, ControlsProps, Controls, ControlButtonProps, ControlButton, ContextClusterProviderProps, ContextClusterProvider, ContextCluster, Common, ClickTransformation, ChildrenOfType, BadgeMinimalProps, BadgeMinimal, BadgeGroupProps, BadgeGroup, AppShellUserExperience, AppShellProps, AppShellNavbarMobileVariant, _default4 as AppShell, AppProviderProps, AppProvider2 as AppProvider, AlertMinimalProps, AlertMinimal, AlertCategory };