@iowas/toolpad 1.0.4 → 1.0.6

package/README.md

@@ -8,7 +8,7 @@ Reusable React components and hooks extracted from this repository.
 pnpm add @iowas/toolpad
 ```
 
-Peer dependencies are required in the consuming app (`react`, `react-dom`, MUI, emotion, and optionally `next` for `toolpad/nextjs`).
+Peer dependencies are required in the consuming app (`react`, `react-dom`, MUI, emotion, and optionally `next` for Next.js integrations in `toolpad/core`).
 
 ## Usage
 
@@ -20,8 +20,7 @@ Use subpath exports when you only need a subset:
 
 ```tsx
 import { AppProvider } from '@iowas/toolpad/core';
-import { useBoolean } from '@iowas/toolpad/utils';
-import { NextAppProvider } from '@iowas/toolpad/nextjs';
+import { NextAppProvider } from '@iowas/toolpad/core';
 ```
 
 ## Build
@@ -52,8 +51,6 @@ pnpm add /absolute/path/to/@iowas%2ftoolpad-1.0.0.tgz
 
 - `@iowas/toolpad`
 - `@iowas/toolpad/core`
-- `@iowas/toolpad/utils`
-- `@iowas/toolpad/nextjs`
 
 ```bash
 npm login

package/dist/core.d.mts

@@ -4,11 +4,9 @@ import Button, { ButtonProps } from '@mui/material/Button';
 import Popover, { PopoverProps } from '@mui/material/Popover';
 import Stack, { StackProps } from '@mui/material/Stack';
 import { AvatarProps } from '@mui/material/Avatar';
-import { SxProps } from '@mui/material/styles';
+import { SxProps, Theme } from '@mui/material/styles';
 import { IconButtonProps } from '@mui/material/IconButton';
 import { BoxProps } from '@mui/material/Box';
-import { B as Branding, i as Navigation, l as NavigationPageItem } from './AppProvider-CIyOzZv_.mjs';
-export { A as AppProvider, a as AppProviderProps, b as AppTheme, c as Authentication, d as AuthenticationContext, L as LocaleText, e as LocalizationContext, f as LocalizationProvider, g as LocalizationProviderProps, N as Navigate, h as NavigateOptions, j as NavigationDividerItem, k as NavigationItem, m as NavigationSubheaderItem, R as Router, S as Session, n as SessionContext, u as useLocaleText } from './AppProvider-CIyOzZv_.mjs';
 import { ContainerProps } from '@mui/material/Container';
 import { SxProps as SxProps$1, SnackbarProps } from '@mui/material';
 
@@ -217,6 +215,202 @@ declare namespace SignOutButton {
     var propTypes: any;
 }
 
+/**
+ * @ignore - internal component.
+ */
+interface LinkProps extends React.AnchorHTMLAttributes<HTMLAnchorElement> {
+    history?: 'auto' | 'push' | 'replace';
+    href: string;
+}
+
+interface LocaleText {
+    accountSignInLabel: string;
+    accountSignOutLabel: string;
+    accountPreviewIconButtonLabel: string;
+    accountPreviewTitle: string;
+    signInTitle: string | ((brandingTitle?: string) => string);
+    signInSubtitle: string;
+    providerSignInTitle: (provider: string) => string;
+    signInRememberMe: string;
+    email: string;
+    passkey: string;
+    username: string;
+    password: string;
+    or: string;
+    to: string;
+    with: string;
+    save: string;
+    cancel: string;
+    ok: string;
+    close: string;
+    delete: string;
+    alert: string;
+    confirm: string;
+    loading: string;
+    createNewButtonLabel: string;
+    reloadButtonLabel: string;
+    createLabel: string;
+    createSuccessMessage: string;
+    createErrorMessage: string;
+    editLabel: string;
+    editSuccessMessage: string;
+    editErrorMessage: string;
+    deleteLabel: string;
+    deleteConfirmTitle: string;
+    deleteConfirmMessage: string;
+    deleteConfirmLabel: string;
+    deleteCancelLabel: string;
+    deleteSuccessMessage: string;
+    deleteErrorMessage: string;
+    deletedItemMessage: string;
+}
+interface LocalizationProviderProps {
+    children?: React.ReactNode;
+    /**
+     * Locale for components texts
+     */
+    localeText?: Partial<LocaleText>;
+}
+declare const LocalizationContext: React.Context<Partial<LocaleText>>;
+declare const LocalizationProvider: {
+    (props: LocalizationProviderProps): react_jsx_runtime.JSX.Element;
+    propTypes: any;
+};
+
+/**
+ *
+ * Demos:
+ *
+ * - [Sign-in Page](https://mui.com/toolpad/core/react-sign-in-page/)
+ *
+ * API:
+ *
+ * - [LocalizationProvider API](https://mui.com/toolpad/core/api/localization-provider)
+ */
+declare function useLocaleText(): Partial<LocaleText>;
+
+interface NavigateOptions {
+    history?: 'auto' | 'push' | 'replace';
+}
+interface Navigate {
+    (url: string | URL, options?: NavigateOptions): void;
+}
+/**
+ * Abstract router used by Toolpad components.
+ */
+interface Router {
+    pathname: string;
+    searchParams: URLSearchParams;
+    navigate: Navigate;
+    Link?: React.ComponentType<LinkProps>;
+}
+interface Branding {
+    title?: string;
+    logo?: React.ReactNode;
+    homeUrl?: string;
+}
+interface NavigationPageItem {
+    kind?: 'page';
+    segment?: string;
+    title?: string;
+    icon?: React.ReactNode;
+    pattern?: string;
+    action?: React.ReactNode;
+    children?: Navigation;
+}
+interface NavigationSubheaderItem {
+    kind: 'header';
+    title: string;
+}
+interface NavigationDividerItem {
+    kind: 'divider';
+}
+type NavigationItem = NavigationPageItem | NavigationSubheaderItem | NavigationDividerItem;
+type Navigation = NavigationItem[];
+interface Session {
+    user?: {
+        id?: string | null;
+        name?: string | null;
+        image?: string | null;
+        email?: string | null;
+    };
+}
+interface Authentication {
+    signIn: () => void;
+    signOut: () => void;
+}
+declare const AuthenticationContext: React.Context<Authentication | null>;
+declare const SessionContext: React.Context<Session | null>;
+type AppTheme = Theme | {
+    light: Theme;
+    dark: Theme;
+};
+interface AppProviderProps {
+    /**
+     * The content of the app provider.
+     */
+    children: React.ReactNode;
+    /**
+     * [Theme or themes](https://mui.com/toolpad/core/react-app-provider/#theming) to be used by the app in light/dark mode. A [CSS variables theme](https://mui.com/material-ui/customization/css-theme-variables/overview/) is recommended.
+     * @default createDefaultTheme()
+     */
+    theme?: AppTheme;
+    /**
+     * Branding options for the app.
+     * @default null
+     */
+    branding?: Branding | null;
+    /**
+     * Navigation definition for the app. [Find out more](https://mui.com/toolpad/core/react-app-provider/#navigation).
+     * @default []
+     */
+    navigation?: Navigation;
+    /**
+     * Router implementation used inside Toolpad components.
+     * @default null
+     */
+    router?: Router;
+    /**
+     * Locale text for components
+     */
+    localeText?: Partial<LocaleText>;
+    /**
+     * Session info about the current user.
+     * @default null
+     */
+    session?: Session | null;
+    /**
+     * Authentication methods.
+     * @default null
+     */
+    authentication?: Authentication | null;
+    /**
+     * The window where the application is rendered.
+     * This is needed when rendering the app inside an iframe, for example.
+     * @default window
+     */
+    window?: Window;
+    /**
+     * The nonce to be used for inline scripts.
+     */
+    nonce?: string;
+}
+/**
+ *
+ * Demos:
+ *
+ * - [App Provider](https://mui.com/toolpad/core/react-app-provider/)
+ * - [Dashboard Layout](https://mui.com/toolpad/core/react-dashboard-layout/)
+ *
+ * API:
+ *
+ * - [AppProvider API](https://mui.com/toolpad/core/api/app-provider)
+ */
+declare function AppProvider(props: AppProviderProps): react_jsx_runtime.JSX.Element;
+declare namespace AppProvider {
+    var propTypes: any;
+}
+
 interface AppTitleProps {
     branding?: Branding;
 }
@@ -992,4 +1186,6 @@ interface NotificationsProviderProps {
  */
 declare function NotificationsProvider(props: NotificationsProviderProps): react_jsx_runtime.JSX.Element;
 
-export { Account, AccountPopoverFooter, type AccountPopoverFooterProps, AccountPopoverHeader, type AccountPopoverHeaderProps, AccountPreview, type AccountPreviewProps, type AccountPreviewSlots, type AccountPreviewVariant, type AccountProps, type AccountSlots, type ActivePage, AlertDialog, type AlertDialogPayload, type AlertDialogProps, type AlertOptions, Branding, type Breadcrumb, type CloseDialog, type CloseNotification, ConfirmDialog, type ConfirmDialogPayload, type ConfirmDialogProps, type ConfirmOptions, DashboardHeader, type DashboardHeaderProps, type DashboardHeaderSlotProps, type DashboardHeaderSlots, DashboardLayout, type DashboardLayoutProps, type DashboardLayoutSlotProps, type DashboardLayoutSlots, DashboardSidebarPageItem, type DashboardSidebarPageItemContextProps, type DashboardSidebarPageItemProps, type DefaultStorageStateoptions, type DialogComponent, type DialogHook, type DialogProps, type DialogProviderProps, DialogsProvider, Navigation, NavigationPageItem, NotificationsProvider, type NotificationsProviderProps, type NotificationsProviderSlotProps, type NotificationsProviderSlots, type OpenAlertDialog, type OpenConfirmDialog, type OpenDialog, type OpenDialogOptions, type OpenPromptDialog, PageContainer, type PageContainerProps, type PageContainerSlotProps, type PageContainerSlots, PageHeader, type PageHeaderProps, type PageHeaderSlotProps, type PageHeaderSlots, PageHeaderToolbar, type PageHeaderToolbarProps, PromptDialog, type PromptDialogPayload, type PromptDialogProps, type PromptOptions, type ShowNotification, type ShowNotificationOptions, type SidebarFooterProps, SignInButton, SignOutButton, type SignOutButtonProps, type StorageStateInitializer, type StorageStateOptions, ThemeSwitcher, ToolbarActions, type UseStorageState, type UseStorageStateHookResult, _default as en, useActivePage, useDialogs, useLocalStorageState, useNotifications, useStorageState, useStorageStateServer };
+declare function NextAppProvider(props: AppProviderProps): react_jsx_runtime.JSX.Element;
+
+export { Account, AccountPopoverFooter, type AccountPopoverFooterProps, AccountPopoverHeader, type AccountPopoverHeaderProps, AccountPreview, type AccountPreviewProps, type AccountPreviewSlots, type AccountPreviewVariant, type AccountProps, type AccountSlots, type ActivePage, AlertDialog, type AlertDialogPayload, type AlertDialogProps, type AlertOptions, AppProvider, type AppProviderProps, type AppTheme, type Authentication, AuthenticationContext, type Branding, type Breadcrumb, type CloseDialog, type CloseNotification, ConfirmDialog, type ConfirmDialogPayload, type ConfirmDialogProps, type ConfirmOptions, DashboardHeader, type DashboardHeaderProps, type DashboardHeaderSlotProps, type DashboardHeaderSlots, DashboardLayout, type DashboardLayoutProps, type DashboardLayoutSlotProps, type DashboardLayoutSlots, DashboardSidebarPageItem, type DashboardSidebarPageItemContextProps, type DashboardSidebarPageItemProps, type DefaultStorageStateoptions, type DialogComponent, type DialogHook, type DialogProps, type DialogProviderProps, DialogsProvider, type LocaleText, LocalizationContext, LocalizationProvider, type LocalizationProviderProps, type Navigate, type NavigateOptions, type Navigation, type NavigationDividerItem, type NavigationItem, type NavigationPageItem, type NavigationSubheaderItem, NextAppProvider, NotificationsProvider, type NotificationsProviderProps, type NotificationsProviderSlotProps, type NotificationsProviderSlots, type OpenAlertDialog, type OpenConfirmDialog, type OpenDialog, type OpenDialogOptions, type OpenPromptDialog, PageContainer, type PageContainerProps, type PageContainerSlotProps, type PageContainerSlots, PageHeader, type PageHeaderProps, type PageHeaderSlotProps, type PageHeaderSlots, PageHeaderToolbar, type PageHeaderToolbarProps, PromptDialog, type PromptDialogPayload, type PromptDialogProps, type PromptOptions, type Router, type Session, SessionContext, type ShowNotification, type ShowNotificationOptions, type SidebarFooterProps, SignInButton, SignOutButton, type SignOutButtonProps, type StorageStateInitializer, type StorageStateOptions, ThemeSwitcher, ToolbarActions, type UseStorageState, type UseStorageStateHookResult, _default as en, useActivePage, useDialogs, useLocalStorageState, useLocaleText, useNotifications, useStorageState, useStorageStateServer };

package/dist/core.d.ts

@@ -4,11 +4,9 @@ import Button, { ButtonProps } from '@mui/material/Button';
 import Popover, { PopoverProps } from '@mui/material/Popover';
 import Stack, { StackProps } from '@mui/material/Stack';
 import { AvatarProps } from '@mui/material/Avatar';
-import { SxProps } from '@mui/material/styles';
+import { SxProps, Theme } from '@mui/material/styles';
 import { IconButtonProps } from '@mui/material/IconButton';
 import { BoxProps } from '@mui/material/Box';
-import { B as Branding, i as Navigation, l as NavigationPageItem } from './AppProvider-CIyOzZv_.js';
-export { A as AppProvider, a as AppProviderProps, b as AppTheme, c as Authentication, d as AuthenticationContext, L as LocaleText, e as LocalizationContext, f as LocalizationProvider, g as LocalizationProviderProps, N as Navigate, h as NavigateOptions, j as NavigationDividerItem, k as NavigationItem, m as NavigationSubheaderItem, R as Router, S as Session, n as SessionContext, u as useLocaleText } from './AppProvider-CIyOzZv_.js';
 import { ContainerProps } from '@mui/material/Container';
 import { SxProps as SxProps$1, SnackbarProps } from '@mui/material';
 
@@ -217,6 +215,202 @@ declare namespace SignOutButton {
     var propTypes: any;
 }
 
+/**
+ * @ignore - internal component.
+ */
+interface LinkProps extends React.AnchorHTMLAttributes<HTMLAnchorElement> {
+    history?: 'auto' | 'push' | 'replace';
+    href: string;
+}
+
+interface LocaleText {
+    accountSignInLabel: string;
+    accountSignOutLabel: string;
+    accountPreviewIconButtonLabel: string;
+    accountPreviewTitle: string;
+    signInTitle: string | ((brandingTitle?: string) => string);
+    signInSubtitle: string;
+    providerSignInTitle: (provider: string) => string;
+    signInRememberMe: string;
+    email: string;
+    passkey: string;
+    username: string;
+    password: string;
+    or: string;
+    to: string;
+    with: string;
+    save: string;
+    cancel: string;
+    ok: string;
+    close: string;
+    delete: string;
+    alert: string;
+    confirm: string;
+    loading: string;
+    createNewButtonLabel: string;
+    reloadButtonLabel: string;
+    createLabel: string;
+    createSuccessMessage: string;
+    createErrorMessage: string;
+    editLabel: string;
+    editSuccessMessage: string;
+    editErrorMessage: string;
+    deleteLabel: string;
+    deleteConfirmTitle: string;
+    deleteConfirmMessage: string;
+    deleteConfirmLabel: string;
+    deleteCancelLabel: string;
+    deleteSuccessMessage: string;
+    deleteErrorMessage: string;
+    deletedItemMessage: string;
+}
+interface LocalizationProviderProps {
+    children?: React.ReactNode;
+    /**
+     * Locale for components texts
+     */
+    localeText?: Partial<LocaleText>;
+}
+declare const LocalizationContext: React.Context<Partial<LocaleText>>;
+declare const LocalizationProvider: {
+    (props: LocalizationProviderProps): react_jsx_runtime.JSX.Element;
+    propTypes: any;
+};
+
+/**
+ *
+ * Demos:
+ *
+ * - [Sign-in Page](https://mui.com/toolpad/core/react-sign-in-page/)
+ *
+ * API:
+ *
+ * - [LocalizationProvider API](https://mui.com/toolpad/core/api/localization-provider)
+ */
+declare function useLocaleText(): Partial<LocaleText>;
+
+interface NavigateOptions {
+    history?: 'auto' | 'push' | 'replace';
+}
+interface Navigate {
+    (url: string | URL, options?: NavigateOptions): void;
+}
+/**
+ * Abstract router used by Toolpad components.
+ */
+interface Router {
+    pathname: string;
+    searchParams: URLSearchParams;
+    navigate: Navigate;
+    Link?: React.ComponentType<LinkProps>;
+}
+interface Branding {
+    title?: string;
+    logo?: React.ReactNode;
+    homeUrl?: string;
+}
+interface NavigationPageItem {
+    kind?: 'page';
+    segment?: string;
+    title?: string;
+    icon?: React.ReactNode;
+    pattern?: string;
+    action?: React.ReactNode;
+    children?: Navigation;
+}
+interface NavigationSubheaderItem {
+    kind: 'header';
+    title: string;
+}
+interface NavigationDividerItem {
+    kind: 'divider';
+}
+type NavigationItem = NavigationPageItem | NavigationSubheaderItem | NavigationDividerItem;
+type Navigation = NavigationItem[];
+interface Session {
+    user?: {
+        id?: string | null;
+        name?: string | null;
+        image?: string | null;
+        email?: string | null;
+    };
+}
+interface Authentication {
+    signIn: () => void;
+    signOut: () => void;
+}
+declare const AuthenticationContext: React.Context<Authentication | null>;
+declare const SessionContext: React.Context<Session | null>;
+type AppTheme = Theme | {
+    light: Theme;
+    dark: Theme;
+};
+interface AppProviderProps {
+    /**
+     * The content of the app provider.
+     */
+    children: React.ReactNode;
+    /**
+     * [Theme or themes](https://mui.com/toolpad/core/react-app-provider/#theming) to be used by the app in light/dark mode. A [CSS variables theme](https://mui.com/material-ui/customization/css-theme-variables/overview/) is recommended.
+     * @default createDefaultTheme()
+     */
+    theme?: AppTheme;
+    /**
+     * Branding options for the app.
+     * @default null
+     */
+    branding?: Branding | null;
+    /**
+     * Navigation definition for the app. [Find out more](https://mui.com/toolpad/core/react-app-provider/#navigation).
+     * @default []
+     */
+    navigation?: Navigation;
+    /**
+     * Router implementation used inside Toolpad components.
+     * @default null
+     */
+    router?: Router;
+    /**
+     * Locale text for components
+     */
+    localeText?: Partial<LocaleText>;
+    /**
+     * Session info about the current user.
+     * @default null
+     */
+    session?: Session | null;
+    /**
+     * Authentication methods.
+     * @default null
+     */
+    authentication?: Authentication | null;
+    /**
+     * The window where the application is rendered.
+     * This is needed when rendering the app inside an iframe, for example.
+     * @default window
+     */
+    window?: Window;
+    /**
+     * The nonce to be used for inline scripts.
+     */
+    nonce?: string;
+}
+/**
+ *
+ * Demos:
+ *
+ * - [App Provider](https://mui.com/toolpad/core/react-app-provider/)
+ * - [Dashboard Layout](https://mui.com/toolpad/core/react-dashboard-layout/)
+ *
+ * API:
+ *
+ * - [AppProvider API](https://mui.com/toolpad/core/api/app-provider)
+ */
+declare function AppProvider(props: AppProviderProps): react_jsx_runtime.JSX.Element;
+declare namespace AppProvider {
+    var propTypes: any;
+}
+
 interface AppTitleProps {
     branding?: Branding;
 }
@@ -992,4 +1186,6 @@ interface NotificationsProviderProps {
  */
 declare function NotificationsProvider(props: NotificationsProviderProps): react_jsx_runtime.JSX.Element;
 
-export { Account, AccountPopoverFooter, type AccountPopoverFooterProps, AccountPopoverHeader, type AccountPopoverHeaderProps, AccountPreview, type AccountPreviewProps, type AccountPreviewSlots, type AccountPreviewVariant, type AccountProps, type AccountSlots, type ActivePage, AlertDialog, type AlertDialogPayload, type AlertDialogProps, type AlertOptions, Branding, type Breadcrumb, type CloseDialog, type CloseNotification, ConfirmDialog, type ConfirmDialogPayload, type ConfirmDialogProps, type ConfirmOptions, DashboardHeader, type DashboardHeaderProps, type DashboardHeaderSlotProps, type DashboardHeaderSlots, DashboardLayout, type DashboardLayoutProps, type DashboardLayoutSlotProps, type DashboardLayoutSlots, DashboardSidebarPageItem, type DashboardSidebarPageItemContextProps, type DashboardSidebarPageItemProps, type DefaultStorageStateoptions, type DialogComponent, type DialogHook, type DialogProps, type DialogProviderProps, DialogsProvider, Navigation, NavigationPageItem, NotificationsProvider, type NotificationsProviderProps, type NotificationsProviderSlotProps, type NotificationsProviderSlots, type OpenAlertDialog, type OpenConfirmDialog, type OpenDialog, type OpenDialogOptions, type OpenPromptDialog, PageContainer, type PageContainerProps, type PageContainerSlotProps, type PageContainerSlots, PageHeader, type PageHeaderProps, type PageHeaderSlotProps, type PageHeaderSlots, PageHeaderToolbar, type PageHeaderToolbarProps, PromptDialog, type PromptDialogPayload, type PromptDialogProps, type PromptOptions, type ShowNotification, type ShowNotificationOptions, type SidebarFooterProps, SignInButton, SignOutButton, type SignOutButtonProps, type StorageStateInitializer, type StorageStateOptions, ThemeSwitcher, ToolbarActions, type UseStorageState, type UseStorageStateHookResult, _default as en, useActivePage, useDialogs, useLocalStorageState, useNotifications, useStorageState, useStorageStateServer };
+declare function NextAppProvider(props: AppProviderProps): react_jsx_runtime.JSX.Element;
+
+export { Account, AccountPopoverFooter, type AccountPopoverFooterProps, AccountPopoverHeader, type AccountPopoverHeaderProps, AccountPreview, type AccountPreviewProps, type AccountPreviewSlots, type AccountPreviewVariant, type AccountProps, type AccountSlots, type ActivePage, AlertDialog, type AlertDialogPayload, type AlertDialogProps, type AlertOptions, AppProvider, type AppProviderProps, type AppTheme, type Authentication, AuthenticationContext, type Branding, type Breadcrumb, type CloseDialog, type CloseNotification, ConfirmDialog, type ConfirmDialogPayload, type ConfirmDialogProps, type ConfirmOptions, DashboardHeader, type DashboardHeaderProps, type DashboardHeaderSlotProps, type DashboardHeaderSlots, DashboardLayout, type DashboardLayoutProps, type DashboardLayoutSlotProps, type DashboardLayoutSlots, DashboardSidebarPageItem, type DashboardSidebarPageItemContextProps, type DashboardSidebarPageItemProps, type DefaultStorageStateoptions, type DialogComponent, type DialogHook, type DialogProps, type DialogProviderProps, DialogsProvider, type LocaleText, LocalizationContext, LocalizationProvider, type LocalizationProviderProps, type Navigate, type NavigateOptions, type Navigation, type NavigationDividerItem, type NavigationItem, type NavigationPageItem, type NavigationSubheaderItem, NextAppProvider, NotificationsProvider, type NotificationsProviderProps, type NotificationsProviderSlotProps, type NotificationsProviderSlots, type OpenAlertDialog, type OpenConfirmDialog, type OpenDialog, type OpenDialogOptions, type OpenPromptDialog, PageContainer, type PageContainerProps, type PageContainerSlotProps, type PageContainerSlots, PageHeader, type PageHeaderProps, type PageHeaderSlotProps, type PageHeaderSlots, PageHeaderToolbar, type PageHeaderToolbarProps, PromptDialog, type PromptDialogPayload, type PromptDialogProps, type PromptOptions, type Router, type Session, SessionContext, type ShowNotification, type ShowNotificationOptions, type SidebarFooterProps, SignInButton, SignOutButton, type SignOutButtonProps, type StorageStateInitializer, type StorageStateOptions, ThemeSwitcher, ToolbarActions, type UseStorageState, type UseStorageStateHookResult, _default as en, useActivePage, useDialogs, useLocalStorageState, useLocaleText, useNotifications, useStorageState, useStorageStateServer };