@strato-admin/faker-ecommerce 0.1.1 → 0.3.0

package/dist/ra-core/src/core/DefaultTitleContext.js

@@ -0,0 +1,15 @@
+import { createContext, useContext } from 'react';
+export const DefaultTitleContext = createContext('React Admin');
+export const DefaultTitleContextProvider = DefaultTitleContext.Provider;
+/**
+ * Get the application title defined at the `<Admin>` level
+ *
+ * @example
+ * import { useDefaultTitle } from 'react-admin';
+ *
+ * const AppBar = () => {
+ *    const defaultTitle = useDefaultTitle();
+ *    return <span>{defaultTitle}</span>;
+ * }
+ */
+export const useDefaultTitle = () => useContext(DefaultTitleContext);

package/dist/ra-core/src/core/HasDashboardContext.d.ts

@@ -0,0 +1,21 @@
+export declare const HasDashboardContext: import("react").Context<boolean>;
+export declare const HasDashboardContextProvider: import("react").Provider<boolean>;
+/**
+ * Returns true if the app has a dashboard defined at the <Admin> level.
+ *
+ * @private
+ * @example
+ * import { useHasDashboard } from 'react-admin';
+ *
+ * const MyMenu = () => {
+ *    const hasDashboard = useHasDashboard();
+ *    return (
+ *       <Menu>
+ *          {hasDashboard && <DashboardMenuItem />}
+ *          <MenuItemLink to="/posts" />
+ *          <MenuItemLink to="/comments" />
+ *       </Menu>
+ *     );
+ * }
+ */
+export declare const useHasDashboard: () => boolean;

package/dist/ra-core/src/core/HasDashboardContext.js

@@ -0,0 +1,22 @@
+import { createContext, useContext } from 'react';
+export const HasDashboardContext = createContext(false);
+export const HasDashboardContextProvider = HasDashboardContext.Provider;
+/**
+ * Returns true if the app has a dashboard defined at the <Admin> level.
+ *
+ * @private
+ * @example
+ * import { useHasDashboard } from 'react-admin';
+ *
+ * const MyMenu = () => {
+ *    const hasDashboard = useHasDashboard();
+ *    return (
+ *       <Menu>
+ *          {hasDashboard && <DashboardMenuItem />}
+ *          <MenuItemLink to="/posts" />
+ *          <MenuItemLink to="/comments" />
+ *       </Menu>
+ *     );
+ * }
+ */
+export const useHasDashboard = () => useContext(HasDashboardContext);

package/dist/ra-core/src/core/ResourceContext.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Context to store the current resource name.
+ *
+ * Use the useResource() hook to read the context. That's what most components do in react-admin.
+ *
+ * @example
+ *
+ * import { useResourceContext, useTranslate } from '@strato-admin/ra-core';
+ *
+ * const MyCustomEditTitle = props => {
+ *     const name = useResourceContext(props);
+ *
+ *     return (
+ *         <h1>{translate(`${name}.name`)}</h1>
+ *     );
+ * };
+ */
+export declare const ResourceContext: import("react").Context<ResourceContextValue>;
+export type ResourceContextValue = string | undefined;

package/dist/ra-core/src/core/ResourceContext.js

@@ -0,0 +1,19 @@
+import { createContext } from 'react';
+/**
+ * Context to store the current resource name.
+ *
+ * Use the useResource() hook to read the context. That's what most components do in react-admin.
+ *
+ * @example
+ *
+ * import { useResourceContext, useTranslate } from '@strato-admin/ra-core';
+ *
+ * const MyCustomEditTitle = props => {
+ *     const name = useResourceContext(props);
+ *
+ *     return (
+ *         <h1>{translate(`${name}.name`)}</h1>
+ *     );
+ * };
+ */
+export const ResourceContext = createContext(undefined);

package/dist/ra-core/src/core/UserMenuContext.d.ts

@@ -0,0 +1,34 @@
+/**
+ * This context provides access to a function for closing the user menu.
+ *
+ * @example
+ * import { Logout, MenuItemLink, UserMenu, useUserMenu } from 'react-admin';
+ *
+ * const ConfigurationMenu = () => {
+ *     const { onClose } = useUserMenu();
+ *     return (
+ *         <MenuItemLink
+ *             to="/configuration"
+ *             primaryText="pos.configuration"
+ *             leftIcon={<SettingsIcon />}
+ *             sidebarIsOpen
+ *             onClick={onClose}
+ *         />
+ *     );
+ * };
+ *
+ * export const MyUserMenu = () => (
+ *     <UserMenu>
+ *         <ConfigurationMenu />
+ *         <Logout />
+ *     </UserMenu>
+ * );
+ */
+export declare const UserMenuContext: import("react").Context<UserMenuContextValue | undefined>;
+export type UserMenuContextValue = {
+    /**
+     * Closes the user menu
+     * @see UserMenu
+     */
+    onClose: () => void;
+};

package/dist/ra-core/src/core/UserMenuContext.js

@@ -0,0 +1,28 @@
+import { createContext } from 'react';
+/**
+ * This context provides access to a function for closing the user menu.
+ *
+ * @example
+ * import { Logout, MenuItemLink, UserMenu, useUserMenu } from 'react-admin';
+ *
+ * const ConfigurationMenu = () => {
+ *     const { onClose } = useUserMenu();
+ *     return (
+ *         <MenuItemLink
+ *             to="/configuration"
+ *             primaryText="pos.configuration"
+ *             leftIcon={<SettingsIcon />}
+ *             sidebarIsOpen
+ *             onClick={onClose}
+ *         />
+ *     );
+ * };
+ *
+ * export const MyUserMenu = () => (
+ *     <UserMenu>
+ *         <ConfigurationMenu />
+ *         <Logout />
+ *     </UserMenu>
+ * );
+ */
+export const UserMenuContext = createContext(undefined);

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

@@ -0,0 +1,27 @@
+export * from './CoreAdmin';
+export * from './CoreAdminContext';
+export * from './CoreAdminRoutes';
+export * from './CoreAdminUI';
+export * from './CustomRoutes';
+export * from './DefaultTitleContext';
+export * from './HasDashboardContext';
+export * from './IsOffline';
+export * from './NavigateToFirstResource';
+export * from './OptionalResourceContextProvider';
+export * from './Resource';
+export * from './ResourceContext';
+export * from './ResourceContextProvider';
+export * from './ResourceDefinitionContext';
+export * from './SourceContext';
+export * from './UserMenuContext';
+export * from './UserMenuContextProvider';
+export * from './useFirstResourceWithListAccess';
+export * from './useGetResourceLabel';
+export * from './useGetRecordRepresentation';
+export * from './useIsOffline';
+export * from './useResourceDefinitionContext';
+export * from './useResourceContext';
+export * from './useResourceDefinition';
+export * from './useResourceDefinitions';
+export * from './useUserMenu';
+export * from './useWrappedSource';

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

@@ -0,0 +1,27 @@
+export * from './CoreAdmin';
+export * from './CoreAdminContext';
+export * from './CoreAdminRoutes';
+export * from './CoreAdminUI';
+export * from './CustomRoutes';
+export * from './DefaultTitleContext';
+export * from './HasDashboardContext';
+export * from './IsOffline';
+export * from './NavigateToFirstResource';
+export * from './OptionalResourceContextProvider';
+export * from './Resource';
+export * from './ResourceContext';
+export * from './ResourceContextProvider';
+export * from './ResourceDefinitionContext';
+export * from './SourceContext';
+export * from './UserMenuContext';
+export * from './UserMenuContextProvider';
+export * from './useFirstResourceWithListAccess';
+export * from './useGetResourceLabel';
+export * from './useGetRecordRepresentation';
+export * from './useIsOffline';
+export * from './useResourceDefinitionContext';
+export * from './useResourceContext';
+export * from './useResourceDefinition';
+export * from './useResourceDefinitions';
+export * from './useUserMenu';
+export * from './useWrappedSource';

package/dist/ra-core/src/core/useGetRecordRepresentation.d.ts

@@ -0,0 +1,13 @@
+import { ReactNode } from 'react';
+/**
+ * Get the default representation of a record (either a string or a React node)
+ *
+ * @example // No customization
+ * const getRecordRepresentation = useGetRecordRepresentation('posts');
+ * getRecordRepresentation({ id: 1, title: 'Hello' }); // => "#1"
+ *
+ * @example // With <Resource name="posts" recordRepresentation="title" />
+ * const getRecordRepresentation = useGetRecordRepresentation('posts');
+ * getRecordRepresentation({ id: 1, title: 'Hello' }); // => "Hello"
+ */
+export declare const useGetRecordRepresentation: (resource?: string) => ((record: any) => ReactNode);

package/dist/ra-core/src/core/useGetRecordRepresentation.js

@@ -0,0 +1,44 @@
+import * as React from 'react';
+import { useCallback } from 'react';
+import get from 'lodash/get.js';
+import { useResourceDefinition } from './useResourceDefinition';
+/**
+ * Get the default representation of a record (either a string or a React node)
+ *
+ * @example // No customization
+ * const getRecordRepresentation = useGetRecordRepresentation('posts');
+ * getRecordRepresentation({ id: 1, title: 'Hello' }); // => "#1"
+ *
+ * @example // With <Resource name="posts" recordRepresentation="title" />
+ * const getRecordRepresentation = useGetRecordRepresentation('posts');
+ * getRecordRepresentation({ id: 1, title: 'Hello' }); // => "Hello"
+ */
+export const useGetRecordRepresentation = (resource) => {
+    const { recordRepresentation } = useResourceDefinition({ resource });
+    return useCallback(record => {
+        if (!record)
+            return '';
+        if (typeof recordRepresentation === 'function') {
+            return recordRepresentation(record);
+        }
+        if (typeof recordRepresentation === 'string') {
+            return get(record, recordRepresentation);
+        }
+        if (React.isValidElement(recordRepresentation)) {
+            return recordRepresentation;
+        }
+        if (record?.name != null && record?.name !== '') {
+            return record.name;
+        }
+        if (record?.title != null && record?.title !== '') {
+            return record.title;
+        }
+        if (record?.label != null && record?.label !== '') {
+            return record.label;
+        }
+        if (record?.reference != null && record?.reference !== '') {
+            return record.reference;
+        }
+        return `#${record.id}`;
+    }, [recordRepresentation]);
+};

package/dist/ra-core/src/core/useGetResourceLabel.d.ts

@@ -0,0 +1,22 @@
+/**
+ * A hook which returns function to get a translated resource name. It will use the label option of the `Resource` component if it was provided.
+ *
+ * @returns {GetResourceLabel} A function which takes a resource name and an optional number indicating the number of items (used for pluralization) and returns a translated string.
+ * @example
+ * const Menu = () => {
+ *     const resources = useResourceDefinitions();
+ *     const getResourceLabel = useGetResourceLabel();
+ *
+ *     return (
+ *         <ul>
+ *             {Object.keys(resources).map(name => (
+ *                 <li key={name}>
+ *                     {getResourceLabel(name, 2)}
+ *                 </li>
+ *             ))}
+ *         </ul>
+ *     )
+ * }
+ */
+export declare const useGetResourceLabel: () => GetResourceLabel;
+export type GetResourceLabel = (resource: string, count?: number) => string;

package/dist/ra-core/src/core/useGetResourceLabel.js

@@ -0,0 +1,42 @@
+import { useResourceDefinitions } from './useResourceDefinitions';
+import { useTranslate } from '../i18n';
+import { humanize, inflect } from 'inflection';
+/**
+ * A hook which returns function to get a translated resource name. It will use the label option of the `Resource` component if it was provided.
+ *
+ * @returns {GetResourceLabel} A function which takes a resource name and an optional number indicating the number of items (used for pluralization) and returns a translated string.
+ * @example
+ * const Menu = () => {
+ *     const resources = useResourceDefinitions();
+ *     const getResourceLabel = useGetResourceLabel();
+ *
+ *     return (
+ *         <ul>
+ *             {Object.keys(resources).map(name => (
+ *                 <li key={name}>
+ *                     {getResourceLabel(name, 2)}
+ *                 </li>
+ *             ))}
+ *         </ul>
+ *     )
+ * }
+ */
+export const useGetResourceLabel = () => {
+    const translate = useTranslate();
+    const definitions = useResourceDefinitions();
+    return (resource, count = 2) => {
+        const resourceDefinition = definitions[resource];
+        const label = translate(`resources.${resource}.name`, {
+            smart_count: count,
+            _: resourceDefinition &&
+                resourceDefinition.options &&
+                resourceDefinition.options.label
+                ? translate(resourceDefinition.options.label, {
+                    smart_count: count,
+                    _: resourceDefinition.options.label,
+                })
+                : humanize(inflect(resource, count)),
+        });
+        return label;
+    };
+};

package/dist/ra-core/src/core/useIsOffline.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Hook to determine if the application is offline.
+ * It uses the onlineManager from react-query to check the online status.
+ * It returns true if the application is offline, false otherwise.
+ * @returns {boolean} - True if offline, false if online.
+ */
+export declare const useIsOffline: () => boolean;

package/dist/ra-core/src/core/useIsOffline.js

@@ -0,0 +1,18 @@
+import * as React from 'react';
+import { onlineManager } from '@tanstack/react-query';
+/**
+ * Hook to determine if the application is offline.
+ * It uses the onlineManager from react-query to check the online status.
+ * It returns true if the application is offline, false otherwise.
+ * @returns {boolean} - True if offline, false if online.
+ */
+export const useIsOffline = () => {
+    const [isOnline, setIsOnline] = React.useState(onlineManager.isOnline());
+    React.useEffect(() => {
+        const handleChange = () => {
+            setIsOnline(onlineManager.isOnline());
+        };
+        return onlineManager.subscribe(handleChange);
+    }, []);
+    return !isOnline;
+};

package/dist/ra-core/src/core/useResourceContext.d.ts

@@ -0,0 +1,36 @@
+import { ResourceContextValue } from './ResourceContext';
+/**
+ * Hook to read the resource from the ResourceContext.
+ *
+ * Must be used within a <ResourceContextProvider> (e.g. as a descendent of <Resource>
+ * or any reference related components), or called with a resource prop.
+ *
+ * @example
+ *
+ * const ResourceName = (props) => {
+ *   const resource = useResourceContext(props);
+ *   const getResourceLabel = useGetResourceLabel();
+ *   return <>{getResourceLabel(resource, 1)}</>;
+ * }
+ *
+ * // use it in a resource context
+ * const MyComponent = () => (
+ *   <ResourceContextProvider value="posts">
+ *     <ResourceName />
+ *     ...
+ *   </ResourceContextProvider>
+ * );
+ *
+ * // override resource via props
+ * const MyComponent = () => (
+ *   <>
+ *     <ResourceName resource="posts"/>
+ *     ...
+ *   </>
+ * );
+ *
+ * @returns {ResourceContextValue} The resource name, e.g. 'posts'
+ */
+export declare const useResourceContext: <ResourceInformationsType extends Partial<{
+    resource: string;
+}>>(props?: ResourceInformationsType) => ResourceContextValue;

package/dist/ra-core/src/core/useResourceContext.js

@@ -0,0 +1,38 @@
+import { useContext } from 'react';
+import { ResourceContext } from './ResourceContext';
+/**
+ * Hook to read the resource from the ResourceContext.
+ *
+ * Must be used within a <ResourceContextProvider> (e.g. as a descendent of <Resource>
+ * or any reference related components), or called with a resource prop.
+ *
+ * @example
+ *
+ * const ResourceName = (props) => {
+ *   const resource = useResourceContext(props);
+ *   const getResourceLabel = useGetResourceLabel();
+ *   return <>{getResourceLabel(resource, 1)}</>;
+ * }
+ *
+ * // use it in a resource context
+ * const MyComponent = () => (
+ *   <ResourceContextProvider value="posts">
+ *     <ResourceName />
+ *     ...
+ *   </ResourceContextProvider>
+ * );
+ *
+ * // override resource via props
+ * const MyComponent = () => (
+ *   <>
+ *     <ResourceName resource="posts"/>
+ *     ...
+ *   </>
+ * );
+ *
+ * @returns {ResourceContextValue} The resource name, e.g. 'posts'
+ */
+export const useResourceContext = (props) => {
+    const context = useContext(ResourceContext);
+    return (props && props.resource) || context;
+};

package/dist/ra-core/src/core/useResourceDefinition.d.ts

@@ -0,0 +1,31 @@
+import { RecordToStringFunction, ResourceDefinition, ResourceOptions } from '../types';
+/**
+ * Hook to get the definition of a given resource
+ *
+ * @example // Get the current resource definition (based on ResourceContext)
+ *
+ * const definition = useResourceDefinition();
+ * console.log(definition);
+ * // {
+ * //   name: 'posts',
+ * //   hasList: true,
+ * //   hasEdit: true,
+ * //   hasShow: true,
+ * //   hasCreate: true,
+ * //   options: {},
+ * //   icon: PostIcon,
+ * // }
+ *
+ * @example // Pass a resource prop to check a different resource definition
+ *
+ * const definition = useResourceDefinition({ resource: 'posts' });
+ */
+export declare const useResourceDefinition: <OptionsType extends ResourceOptions = any>(props?: UseResourceDefinitionOptions) => ResourceDefinition<OptionsType>;
+export interface UseResourceDefinitionOptions {
+    readonly resource?: string;
+    readonly hasList?: boolean;
+    readonly hasEdit?: boolean;
+    readonly hasShow?: boolean;
+    readonly hasCreate?: boolean;
+    readonly recordRepresentation?: React.ReactNode | RecordToStringFunction;
+}

package/dist/ra-core/src/core/useResourceDefinition.js

@@ -0,0 +1,48 @@
+import { useMemo } from 'react';
+import defaults from 'lodash/defaults.js';
+import { useResourceDefinitions } from './useResourceDefinitions';
+import { useResourceContext } from './useResourceContext';
+/**
+ * Hook to get the definition of a given resource
+ *
+ * @example // Get the current resource definition (based on ResourceContext)
+ *
+ * const definition = useResourceDefinition();
+ * console.log(definition);
+ * // {
+ * //   name: 'posts',
+ * //   hasList: true,
+ * //   hasEdit: true,
+ * //   hasShow: true,
+ * //   hasCreate: true,
+ * //   options: {},
+ * //   icon: PostIcon,
+ * // }
+ *
+ * @example // Pass a resource prop to check a different resource definition
+ *
+ * const definition = useResourceDefinition({ resource: 'posts' });
+ */
+export const useResourceDefinition = (props) => {
+    const resource = useResourceContext(props);
+    const resourceDefinitions = useResourceDefinitions();
+    const { hasCreate, hasEdit, hasList, hasShow, recordRepresentation } = props || {};
+    const definition = useMemo(() => {
+        return defaults({}, {
+            hasCreate,
+            hasEdit,
+            hasList,
+            hasShow,
+            recordRepresentation,
+        }, resource ? resourceDefinitions[resource] : {});
+    }, [
+        resource,
+        resourceDefinitions,
+        hasCreate,
+        hasEdit,
+        hasList,
+        hasShow,
+        recordRepresentation,
+    ]);
+    return definition;
+};

package/dist/ra-core/src/core/useResourceDefinitionContext.d.ts

@@ -0,0 +1 @@
+export declare const useResourceDefinitionContext: () => unknown;

package/dist/ra-core/src/core/useResourceDefinitionContext.js

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

package/dist/ra-core/src/core/useResourceDefinitions.d.ts

@@ -0,0 +1,21 @@
+import type { ResourceOptions } from '../types';
+import type { ResourceDefinitions } from './ResourceDefinitionContext';
+/**
+ * Get the definition of the all resources
+ *
+ * @example
+ *
+ * const definitions = useResourceDefinitions();
+ * console.log(definitions.posts);
+ * // {
+ * //   name: 'posts',
+ * //   hasList: true,
+ * //   hasEdit: true,
+ * //   hasShow: true,
+ * //   hasCreate: true,
+ * //   options: {},
+ * //   icon: PostIcon,
+ * //   recordRepresentation: 'title',
+ * // }
+ */
+export declare const useResourceDefinitions: <OptionsType extends ResourceOptions = any>() => ResourceDefinitions<OptionsType>;

package/dist/ra-core/src/core/useResourceDefinitions.js

@@ -0,0 +1,20 @@
+import { useResourceDefinitionContext } from './useResourceDefinitionContext';
+/**
+ * Get the definition of the all resources
+ *
+ * @example
+ *
+ * const definitions = useResourceDefinitions();
+ * console.log(definitions.posts);
+ * // {
+ * //   name: 'posts',
+ * //   hasList: true,
+ * //   hasEdit: true,
+ * //   hasShow: true,
+ * //   hasCreate: true,
+ * //   options: {},
+ * //   icon: PostIcon,
+ * //   recordRepresentation: 'title',
+ * // }
+ */
+export const useResourceDefinitions = () => useResourceDefinitionContext().definitions;

package/dist/ra-core/src/core/useUserMenu.d.ts

@@ -0,0 +1,28 @@
+/**
+ * A hook to retrieve the user menu context, which provides access to a function for closing the user menu.
+ * @returns {UserMenuContextValue}
+ *
+ * @example
+ * import { Logout, MenuItemLink, UserMenu, useUserMenu } from 'react-admin';
+ *
+ * const ConfigurationMenu = () => {
+ *     const { onClose } = useUserMenu();
+ *     return (
+ *         <MenuItemLink
+ *             to="/configuration"
+ *             primaryText="pos.configuration"
+ *             leftIcon={<SettingsIcon />}
+ *             sidebarIsOpen
+ *             onClick={onClose}
+ *         />
+ *     );
+ * };
+ *
+ * export const MyUserMenu = () => (
+ *     <UserMenu>
+ *         <ConfigurationMenu />
+ *         <Logout />
+ *     </UserMenu>
+ * );
+ */
+export declare const useUserMenu: () => import("./UserMenuContext").UserMenuContextValue | undefined;

package/dist/ra-core/src/core/useUserMenu.js

@@ -0,0 +1,30 @@
+import { useContext } from 'react';
+import { UserMenuContext } from './UserMenuContext';
+/**
+ * A hook to retrieve the user menu context, which provides access to a function for closing the user menu.
+ * @returns {UserMenuContextValue}
+ *
+ * @example
+ * import { Logout, MenuItemLink, UserMenu, useUserMenu } from 'react-admin';
+ *
+ * const ConfigurationMenu = () => {
+ *     const { onClose } = useUserMenu();
+ *     return (
+ *         <MenuItemLink
+ *             to="/configuration"
+ *             primaryText="pos.configuration"
+ *             leftIcon={<SettingsIcon />}
+ *             sidebarIsOpen
+ *             onClick={onClose}
+ *         />
+ *     );
+ * };
+ *
+ * export const MyUserMenu = () => (
+ *     <UserMenu>
+ *         <ConfigurationMenu />
+ *         <Logout />
+ *     </UserMenu>
+ * );
+ */
+export const useUserMenu = () => useContext(UserMenuContext);

package/dist/ra-core/src/core/useWrappedSource.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Get the source prop for a field or input by checking if a source context is available.
+ * @param {string} source The original source prop
+ * @returns {string} The source prop, either the original one or the one modified by the SourceContext.
+ * @example
+ * const MyInput = ({ source, ...props }) => {
+ *   const finalSource = useWrappedSource(source);
+ *   return <input name={finalSource} {...props} />;
+ * };
+ */
+export declare const useWrappedSource: (source: string) => any;