@strato-admin/faker-ecommerce 0.1.1 → 0.3.0

package/dist/ra-core/src/notification/NotificationContext.d.ts

@@ -0,0 +1,37 @@
+import { Dispatch, SetStateAction } from 'react';
+import { NotificationPayload } from './types';
+export type NotificationContextType = {
+    notifications: NotificationPayload[];
+    addNotification: (notification: NotificationPayload) => void;
+    takeNotification: () => NotificationPayload | void;
+    resetNotifications: () => void;
+    setNotifications: Dispatch<SetStateAction<NotificationPayload[]>>;
+};
+/**
+ * Context for the notification state and modifiers
+ *
+ * @example // display notifications
+ * import { useNotificationContext } from 'react-admin';
+ *
+ * const App = () => {
+ *    const { notifications } = useNotificationContext();
+ *    return (
+ *        <ul>
+ *            {notifications.map(({ message }) => (
+ *                <li key={index}>{ message }</li>
+ *            ))}
+ *        </ul>
+ *    );
+ * };
+ *
+ * @example // reset notifications
+ * import { useNotificationContext } from 'react-admin';
+ *
+ * const ResetNotificationsButton = () => {
+ *    const { resetNotifications } = useNotificationContext();
+ *    return (
+ *        <button onClick={() => resetNotifications()}>Reset notifications</button>
+ *    );
+ * };
+ */
+export declare const NotificationContext: import("react").Context<NotificationContextType>;

package/dist/ra-core/src/notification/NotificationContext.js

@@ -0,0 +1,35 @@
+import { createContext } from 'react';
+/**
+ * Context for the notification state and modifiers
+ *
+ * @example // display notifications
+ * import { useNotificationContext } from 'react-admin';
+ *
+ * const App = () => {
+ *    const { notifications } = useNotificationContext();
+ *    return (
+ *        <ul>
+ *            {notifications.map(({ message }) => (
+ *                <li key={index}>{ message }</li>
+ *            ))}
+ *        </ul>
+ *    );
+ * };
+ *
+ * @example // reset notifications
+ * import { useNotificationContext } from 'react-admin';
+ *
+ * const ResetNotificationsButton = () => {
+ *    const { resetNotifications } = useNotificationContext();
+ *    return (
+ *        <button onClick={() => resetNotifications()}>Reset notifications</button>
+ *    );
+ * };
+ */
+export const NotificationContext = createContext({
+    notifications: [],
+    addNotification: () => { },
+    takeNotification: () => { },
+    resetNotifications: () => { },
+    setNotifications: () => { },
+});

package/dist/ra-core/src/notification/index.d.ts

@@ -0,0 +1,9 @@
+export * from './AddNotificationContext';
+export * from './CloseNotificationContext';
+export * from './NotificationContext';
+export * from './NotificationContextProvider';
+export * from './types';
+export * from './useAddNotificationContext';
+export * from './useCloseNotification';
+export * from './useNotificationContext';
+export * from './useNotify';

package/dist/ra-core/src/notification/index.js

@@ -0,0 +1,9 @@
+export * from './AddNotificationContext';
+export * from './CloseNotificationContext';
+export * from './NotificationContext';
+export * from './NotificationContextProvider';
+export * from './types';
+export * from './useAddNotificationContext';
+export * from './useCloseNotification';
+export * from './useNotificationContext';
+export * from './useNotify';

package/dist/ra-core/src/notification/types.d.ts

@@ -0,0 +1,14 @@
+import { ReactNode } from 'react';
+export type NotificationType = 'success' | 'info' | 'warning' | 'error';
+export interface NotificationOptions {
+    autoHideDuration?: number | null;
+    messageArgs?: any;
+    multiLine?: boolean;
+    undoable?: boolean;
+    [key: string]: any;
+}
+export interface NotificationPayload {
+    readonly message: string | ReactNode;
+    readonly type: NotificationType;
+    readonly notificationOptions?: NotificationOptions;
+}

package/dist/ra-core/src/notification/types.js

@@ -0,0 +1 @@
+export {};

package/dist/ra-core/src/notification/useCloseNotification.d.ts

@@ -0,0 +1 @@
+export declare const useCloseNotification: () => import("./CloseNotificationContext").CloseNotificationContextValue;

package/dist/ra-core/src/notification/useCloseNotification.js

@@ -0,0 +1,9 @@
+import { useContext } from 'react';
+import { CloseNotificationContext } from './CloseNotificationContext';
+export const useCloseNotification = () => {
+    const closeNotification = useContext(CloseNotificationContext);
+    if (!closeNotification) {
+        throw new Error('useCloseNotification must be used within a CloseNotificationContext.Provider');
+    }
+    return closeNotification;
+};

package/dist/ra-core/src/notification/useNotificationContext.d.ts

@@ -0,0 +1 @@
+export declare const useNotificationContext: () => import("./NotificationContext").NotificationContextType;

package/dist/ra-core/src/notification/useNotificationContext.js

@@ -0,0 +1,3 @@
+import { useContext } from 'react';
+import { NotificationContext } from './NotificationContext';
+export const useNotificationContext = () => useContext(NotificationContext);

package/dist/ra-core/src/notification/useNotify.d.ts

@@ -0,0 +1,20 @@
+import { ReactNode } from 'react';
+import { NotificationType, NotificationOptions } from './types';
+/**
+ * Hook for Notification Side Effect
+ *
+ * @example
+ *
+ * const notify = useNotify();
+ * // simple message (info level)
+ * notify('Level complete');
+ * // specify level
+ * notify('A problem occurred', { type: 'error' })
+ * // pass arguments to the translation function
+ * notify('Deleted %{count} elements', { type: 'info', messageArgs: { smart_count: 23 } })
+ * // show the action as undoable in the notification
+ * notify('Post renamed', { type: 'info', undoable: true })
+ */
+export declare const useNotify: () => (message: string | ReactNode, options?: NotificationOptions & {
+    type?: NotificationType;
+}) => void;

package/dist/ra-core/src/notification/useNotify.js

@@ -0,0 +1,28 @@
+import { useCallback } from 'react';
+import { useAddNotificationContext } from './useAddNotificationContext';
+/**
+ * Hook for Notification Side Effect
+ *
+ * @example
+ *
+ * const notify = useNotify();
+ * // simple message (info level)
+ * notify('Level complete');
+ * // specify level
+ * notify('A problem occurred', { type: 'error' })
+ * // pass arguments to the translation function
+ * notify('Deleted %{count} elements', { type: 'info', messageArgs: { smart_count: 23 } })
+ * // show the action as undoable in the notification
+ * notify('Post renamed', { type: 'info', undoable: true })
+ */
+export const useNotify = () => {
+    const addNotification = useAddNotificationContext();
+    return useCallback((message, options = {}) => {
+        const { type: messageType = 'info', ...notificationOptions } = options;
+        addNotification({
+            message,
+            type: messageType,
+            notificationOptions,
+        });
+    }, [addNotification]);
+};

package/dist/ra-core/src/preferences/index.d.ts

@@ -0,0 +1,7 @@
+export * from './PreferencesEditorContext';
+export * from './PreferencesEditorContextProvider';
+export * from './usePreference';
+export * from './usePreferencesEditor';
+export * from './usePreferenceInput';
+export * from './useSetInspectorTitle';
+export * from './PreferenceKeyContext';

package/dist/ra-core/src/preferences/index.js

@@ -0,0 +1,7 @@
+export * from './PreferencesEditorContext';
+export * from './PreferencesEditorContextProvider';
+export * from './usePreference';
+export * from './usePreferencesEditor';
+export * from './usePreferenceInput';
+export * from './useSetInspectorTitle';
+export * from './PreferenceKeyContext';

package/dist/ra-core/src/preferences/usePreference.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Get a preference value from the store
+ *
+ * Relies on the store, using a key namespaced with the preference key from the PreferenceKeyContext
+ * @example
+ *
+ * // when used inside a PreferenceKeyContext of value 'my-app'
+ * const [theme, setTheme] = usePreference('theme', 'light');
+ * // this is equivalent to
+ * const [theme, setTheme] = useStore('my-app.theme', 'light');
+ */
+declare function usePreference<T>(key: string, defaultValue: T): [T, (value: T | ((value: T) => void), defaultValue?: T) => void];
+declare function usePreference<T = undefined>(key: string, defaultValue?: T | undefined): [T | undefined, (value: T | ((value: T) => void), defaultValue?: T) => void];
+declare function usePreference(): [
+    unknown,
+    (value: unknown | ((value: unknown) => void), defaultValue?: unknown) => void
+];
+export { usePreference };

package/dist/ra-core/src/preferences/usePreference.js

@@ -0,0 +1,10 @@
+import { useStore } from '../store/useStore';
+import { usePreferenceKey } from './PreferenceKeyContext';
+function usePreference(key = '', defaultValue = undefined) {
+    const preferenceKey = usePreferenceKey();
+    if (!preferenceKey) {
+        throw new Error("usePreference cannot be used outside of a Configurable component. Did you forget to wrap your component with <Configurable>? If you don't want to use Configurable, you can use the useStore hook instead.");
+    }
+    return useStore(preferenceKey && key ? `${preferenceKey}.${key}` : preferenceKey ?? key, defaultValue);
+}
+export { usePreference };

package/dist/ra-core/src/preferences/usePreferenceInput.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Get the props for a preference input that changes the value on blur
+ *
+ * Relies on `usePreference`, so it's using the PreferenceKeyContext
+ *
+ * @example
+ * const FontSizePreferenceInput = () => {
+ *     const field = usePreferenceInput('ui.font.size', 10);
+ *     return (
+ *         <div>
+ *             <label for="font-size">Font size</label>
+ *             <input id="font-size" {...field} />
+ *         </div>
+ *     );
+ * }
+ */
+export declare const usePreferenceInput: (key: string, defaultValue?: any) => {
+    value: any;
+    onChange: (event: any) => void;
+    onBlur: () => void;
+    onKeyDown: (event: any) => void;
+};

package/dist/ra-core/src/preferences/usePreferenceInput.js

@@ -0,0 +1,43 @@
+import { useState, useEffect } from 'react';
+import { usePreference } from './usePreference';
+/**
+ * Get the props for a preference input that changes the value on blur
+ *
+ * Relies on `usePreference`, so it's using the PreferenceKeyContext
+ *
+ * @example
+ * const FontSizePreferenceInput = () => {
+ *     const field = usePreferenceInput('ui.font.size', 10);
+ *     return (
+ *         <div>
+ *             <label for="font-size">Font size</label>
+ *             <input id="font-size" {...field} />
+ *         </div>
+ *     );
+ * }
+ */
+export const usePreferenceInput = (key, defaultValue) => {
+    const [valueFromStore, setValueFromStore] = usePreference(key, defaultValue);
+    const [value, setValue] = useState(valueFromStore);
+    useEffect(() => {
+        setValue(valueFromStore || defaultValue);
+    }, [valueFromStore, defaultValue]);
+    const onChange = event => {
+        setValue(event.target.value === '' ? defaultValue : event.target.value);
+    };
+    const onBlur = () => {
+        setValueFromStore(value);
+    };
+    const onKeyDown = event => {
+        if (event.key === 'Enter') {
+            setValueFromStore(value);
+            const form = event.target.form;
+            if (form) {
+                const index = [...form].indexOf(event.target);
+                form.elements[index + 1]?.focus();
+            }
+            event.preventDefault();
+        }
+    };
+    return { value, onChange, onBlur, onKeyDown };
+};

package/dist/ra-core/src/preferences/usePreferencesEditor.d.ts

@@ -0,0 +1,2 @@
+import { PreferencesEditorContextValue } from './PreferencesEditorContext';
+export declare const usePreferencesEditor: () => PreferencesEditorContextValue;

package/dist/ra-core/src/preferences/usePreferencesEditor.js

@@ -0,0 +1,9 @@
+import { useContext } from 'react';
+import { PreferencesEditorContext, } from './PreferencesEditorContext';
+export const usePreferencesEditor = () => {
+    const context = useContext(PreferencesEditorContext);
+    if (!context) {
+        throw new Error('usePreferencesEditor must be used within a PreferencesEditorContextProvider');
+    }
+    return context;
+};

package/dist/ra-core/src/preferences/useSetInspectorTitle.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Set inspector title on mount
+ *
+ * @example
+ * useSetInspectorTitle('Datagrid');
+ */
+export declare const useSetInspectorTitle: (title: string, options?: any) => void;

package/dist/ra-core/src/preferences/useSetInspectorTitle.js

@@ -0,0 +1,19 @@
+import { useEffect } from 'react';
+import { usePreferencesEditor } from './usePreferencesEditor';
+/**
+ * Set inspector title on mount
+ *
+ * @example
+ * useSetInspectorTitle('Datagrid');
+ */
+export const useSetInspectorTitle = (title, options) => {
+    const preferencesEditorContext = usePreferencesEditor();
+    if (!preferencesEditorContext) {
+        throw new Error('useSetInspectorTitle cannot be called outside of a PreferencesEditorContext');
+    }
+    const { setTitle } = preferencesEditorContext;
+    useEffect(() => {
+        setTitle(title, options);
+        // eslint-disable-next-line react-hooks/exhaustive-deps
+    }, [title, JSON.stringify(options), setTitle]);
+};

package/dist/ra-core/src/routing/BasenameContext.d.ts

@@ -0,0 +1 @@
+export declare const BasenameContext: import("react").Context<string>;

package/dist/ra-core/src/routing/BasenameContext.js

@@ -0,0 +1,2 @@
+import { createContext } from 'react';
+export const BasenameContext = createContext('');

package/dist/ra-core/src/routing/RouterProvider.d.ts

@@ -0,0 +1,163 @@
+import { ComponentType, ReactNode } from 'react';
+export interface RouterLocation {
+    pathname: string;
+    search: string;
+    hash: string;
+    state?: any;
+    key?: string;
+}
+export interface RouterNavigateOptions {
+    replace?: boolean;
+    state?: any;
+}
+export type RouterNavigateFunction = (to: string | Partial<RouterLocation> | number, options?: RouterNavigateOptions) => void;
+export interface RouterBlockerBlocked {
+    state: 'blocked';
+    reset: () => void;
+    proceed: () => void;
+    location: RouterLocation;
+}
+export interface RouterBlockerUnblocked {
+    state: 'unblocked';
+    reset: undefined;
+    proceed: undefined;
+    location: undefined;
+}
+export interface RouterBlockerProceeding {
+    state: 'proceeding';
+    reset: undefined;
+    proceed: undefined;
+    location: RouterLocation;
+}
+export type RouterBlocker = RouterBlockerBlocked | RouterBlockerUnblocked | RouterBlockerProceeding;
+export type RouterHistoryAction = 'POP' | 'PUSH' | 'REPLACE';
+export type RouterBlockerFunction = (args: {
+    currentLocation: RouterLocation;
+    nextLocation: RouterLocation;
+    historyAction: RouterHistoryAction;
+}) => boolean;
+export interface RouterMatch {
+    params: Record<string, string | undefined>;
+    pathname: string;
+    pathnameBase: string;
+}
+export type RouterTo = string | Partial<RouterLocation>;
+export interface RouterLinkProps {
+    to: RouterTo;
+    replace?: boolean;
+    state?: any;
+    children?: ReactNode;
+    className?: string;
+    [key: string]: any;
+}
+export interface RouterNavigateProps {
+    to: string | Partial<RouterLocation>;
+    replace?: boolean;
+    state?: any;
+}
+export interface RouterRouteProps {
+    path?: string;
+    element?: ReactNode;
+    children?: ReactNode;
+    index?: boolean;
+}
+export interface RouterRoutesProps {
+    children: ReactNode;
+    location?: RouterLocation | string;
+}
+export interface RouterOutletProps {
+    context?: any;
+}
+export interface RouterWrapperProps {
+    basename?: string;
+    children: ReactNode;
+}
+/**
+ * The RouterProvider interface defines all routing primitives used by ra-core.
+ * Implement this interface to use a different router library (e.g., TanStack Router).
+ *
+ * @example
+ * // Using the default react-router provider (no configuration needed)
+ * <Admin dataProvider={dataProvider}>
+ *   <Resource name="posts" list={PostList} />
+ * </Admin>
+ *
+ * @example
+ * // Using a custom router provider
+ * import { tanStackRouterProvider } from '@strato-admin/ra-core';
+ *
+ * <Admin dataProvider={dataProvider} routerProvider={tanStackRouterProvider}>
+ *   <Resource name="posts" list={PostList} />
+ * </Admin>
+ */
+export interface RouterProvider {
+    /**
+     * Returns the current location object.
+     */
+    useLocation: () => RouterLocation;
+    /**
+     * Returns a function to navigate programmatically.
+     */
+    useNavigate: () => RouterNavigateFunction;
+    /**
+     * Returns route parameters as key-value pairs.
+     */
+    useParams: <T extends Record<string, string | undefined> = Record<string, string | undefined>>() => T;
+    /**
+     * Blocks navigation based on a condition.
+     * Used by useWarnWhenUnsavedChanges to prevent losing form data.
+     */
+    useBlocker: (shouldBlock: RouterBlockerFunction | boolean) => RouterBlocker;
+    /**
+     * Returns a match object if the current location matches the given pattern.
+     */
+    useMatch: (pattern: {
+        path: string;
+        end?: boolean;
+    }) => RouterMatch | null;
+    /**
+     * Returns whether we are currently inside a router context.
+     */
+    useInRouterContext: () => boolean;
+    /**
+     * Returns whether navigation blocking (useBlocker) is supported in the current context.
+     * For react-router, this requires a data router. For other routers, it may always be true.
+     */
+    useCanBlock: () => boolean;
+    /**
+     * Link component for navigation.
+     */
+    Link: ComponentType<RouterLinkProps>;
+    /**
+     * Component for programmatic/declarative navigation.
+     */
+    Navigate: ComponentType<RouterNavigateProps>;
+    /**
+     * Route definition component.
+     */
+    Route: ComponentType<RouterRouteProps>;
+    /**
+     * Routes container component.
+     */
+    Routes: ComponentType<RouterRoutesProps>;
+    /**
+     * Outlet for nested routes.
+     */
+    Outlet: ComponentType<RouterOutletProps>;
+    /**
+     * Matches a path pattern against a pathname.
+     */
+    matchPath: (pattern: string | {
+        path: string;
+        end?: boolean;
+    }, pathname: string) => RouterMatch | null;
+    /**
+     * Component that wraps children with a router if not already in a router context.
+     *
+     * The component should:
+     * 1. Check if already inside a router context (using useInRouterContext)
+     * 2. If yes, render children directly
+     * 3. If no, wrap children with a router
+     */
+    RouterWrapper: ComponentType<RouterWrapperProps>;
+}

package/dist/ra-core/src/routing/RouterProvider.js

@@ -0,0 +1 @@
+export {};

package/dist/ra-core/src/routing/index.d.ts

@@ -0,0 +1,28 @@
+export * from './AdminRouter';
+export * from './BasenameContextProvider';
+export * from './RestoreScrollPosition';
+export * from './useBasename';
+export * from './useCreatePath';
+export * from './useGetPathForRecord';
+export * from './useGetPathForRecordCallback';
+export * from './useRedirect';
+export * from './useResetErrorBoundaryOnLocationChange';
+export * from './useScrollToTop';
+export * from './useRestoreScrollPosition';
+export * from './types';
+export * from './TestMemoryRouter';
+export * from './useSplatPathBase';
+export * from './RouterProvider';
+export * from './RouterProviderContext';
+export * from './adapters/reactRouterProvider';
+export * from './useLocation';
+export * from './useNavigate';
+export * from './useParams';
+export * from './useBlocker';
+export * from './useMatch';
+export * from './useInRouterContext';
+export * from './useCanBlock';
+export * from './useMatchPath';
+export * from './LinkBase';
+export * from './Navigate';
+export * from './Outlet';

package/dist/ra-core/src/routing/index.js

@@ -0,0 +1,28 @@
+export * from './AdminRouter';
+export * from './BasenameContextProvider';
+export * from './RestoreScrollPosition';
+export * from './useBasename';
+export * from './useCreatePath';
+export * from './useGetPathForRecord';
+export * from './useGetPathForRecordCallback';
+export * from './useRedirect';
+export * from './useResetErrorBoundaryOnLocationChange';
+export * from './useScrollToTop';
+export * from './useRestoreScrollPosition';
+export * from './types';
+export * from './TestMemoryRouter';
+export * from './useSplatPathBase';
+export * from './RouterProvider';
+export * from './RouterProviderContext';
+export * from './adapters/reactRouterProvider';
+export * from './useLocation';
+export * from './useNavigate';
+export * from './useParams';
+export * from './useBlocker';
+export * from './useMatch';
+export * from './useInRouterContext';
+export * from './useCanBlock';
+export * from './useMatchPath';
+export * from './LinkBase';
+export * from './Navigate';
+export * from './Outlet';

package/dist/ra-core/src/routing/types.d.ts

@@ -0,0 +1,3 @@
+import { RaRecord } from '../types';
+export type LinkToFunctionType<RecordType extends RaRecord = RaRecord> = (record: RecordType, reference: string) => string | false | Promise<string | false>;
+export type LinkToType<RecordType extends RaRecord = RaRecord> = string | false | LinkToFunctionType<RecordType>;

package/dist/ra-core/src/routing/types.js

@@ -0,0 +1 @@
+export {};

package/dist/ra-core/src/routing/useBasename.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Get the string to append to all links to the admin app.
+ *
+ * Useful when the app is mounted on a sub path, e.g. '/admin'.
+ *
+ * This hook is used internally by all react-admin components that
+ * contain a link, and requires that the basename is set via the
+ * `<BasenameContextProvider>` component (or via the `<Admin>` component,
+ * which calls BasenameContextProvider internally).
+ *
+ * @see BasenameContextProvider
+ *
+ * @example
+ * import { useBasename } from 'react-admin';
+ *
+ * const ArticleLink = ({ title, id }) => {
+ *    const basename = useBasename();
+ *    return <a href={`${basename}/articles/${id}`}>{title}</a>;
+ * };
+ */
+export declare const useBasename: () => string;

package/dist/ra-core/src/routing/useBasename.js

@@ -0,0 +1,23 @@
+import { useContext } from 'react';
+import { BasenameContext } from './BasenameContext';
+/**
+ * Get the string to append to all links to the admin app.
+ *
+ * Useful when the app is mounted on a sub path, e.g. '/admin'.
+ *
+ * This hook is used internally by all react-admin components that
+ * contain a link, and requires that the basename is set via the
+ * `<BasenameContextProvider>` component (or via the `<Admin>` component,
+ * which calls BasenameContextProvider internally).
+ *
+ * @see BasenameContextProvider
+ *
+ * @example
+ * import { useBasename } from 'react-admin';
+ *
+ * const ArticleLink = ({ title, id }) => {
+ *    const basename = useBasename();
+ *    return <a href={`${basename}/articles/${id}`}>{title}</a>;
+ * };
+ */
+export const useBasename = () => useContext(BasenameContext);

package/dist/ra-core/src/routing/useBlocker.d.ts

@@ -0,0 +1,14 @@
+import type { RouterBlocker, RouterBlockerFunction } from './RouterProvider';
+/**
+ * Hook to block navigation based on a condition.
+ * This is a router-agnostic wrapper that uses the configured router provider.
+ * Used by useWarnWhenUnsavedChanges to prevent losing form data.
+ *
+ * @example
+ * const blocker = useBlocker(shouldBlock);
+ * if (blocker.state === 'blocked') {
+ *   // Show confirmation dialog
+ *   blocker.proceed(); // or blocker.reset();
+ * }
+ */
+export declare const useBlocker: (shouldBlock: RouterBlockerFunction | boolean) => RouterBlocker;