remoraid 3.3.2 → 3.5.0

package/dist/core/index.d.ts

@@ -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 {
@@ -298,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";
@@ -368,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> {
@@ -399,6 +434,7 @@ interface NavbarMinimalContentProps {
 	orientation: NavbarOrientation;
 	maxElements?: number;
 	collapseStaticElementsBreakpoint?: MantineBreakpoint3;
+	includeDefaultNavigationElements?: boolean;
 	componentsProps?: {
 		container?: Partial<PaperProps>
 		button?: Partial<RemoraidButtonProps<true>> | Partial<RemoraidButtonProps<false>>
@@ -491,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>
@@ -498,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?: {
@@ -524,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>
@@ -838,4 +871,4 @@ interface InputWrapperScrollAreaProps {
 	};
 }
 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 };