@strato-admin/core 0.1.0 → 0.3.0

package/dist/ra-core/src/controller/list/ListBase.d.ts

@@ -0,0 +1,48 @@
+import { ReactNode } from 'react';
+import { ListControllerProps, ListControllerResult } from './useListController';
+import { RaRecord } from '../../types';
+/**
+ * Call useListController and put the value in a ListContext
+ *
+ * Base class for <List> components, without UI.
+ *
+ * Accepts any props accepted by useListController:
+ * - filter: permanent filter applied to the list
+ * - filters: Filter element, to display the filters
+ * - filterDefaultValues: object;
+ * - perPage: Number of results per page
+ * - sort: Default sort
+ * - exporter: exported function
+ *
+ * @example // Custom list layout
+ *
+ * const PostList = () => (
+ *     <ListBase perPage={10}>
+ *         <div>
+ *              List metrics...
+ *         </div>
+ *         <Grid container>
+ *             <Grid item xs={8}>
+ *                 <SimpleList primaryText={record => record.title} />
+ *             </Grid>
+ *             <Grid item xs={4}>
+ *                 List instructions...
+ *             </Grid>
+ *         </Grid>
+ *         <div>
+ *             Post related links...
+ *         </div>
+ *     </ListBase>
+ * );
+ */
+export declare const ListBase: <RecordType extends RaRecord = any>({ children, emptyWhileLoading, authLoading, loading, offline, error, empty, render, ...props }: ListBaseProps<RecordType>) => import("react/jsx-runtime").JSX.Element;
+export interface ListBaseProps<RecordType extends RaRecord = any> extends ListControllerProps<RecordType> {
+    emptyWhileLoading?: boolean;
+    authLoading?: ReactNode;
+    loading?: ReactNode;
+    offline?: ReactNode;
+    error?: ReactNode;
+    empty?: ReactNode;
+    children?: ReactNode;
+    render?: (props: ListControllerResult<RecordType, Error>) => ReactNode;
+}

package/dist/ra-core/src/controller/list/ListBase.js

@@ -0,0 +1,98 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { useListController, } from './useListController';
+import { OptionalResourceContextProvider } from '../../core';
+import { ListContextProvider } from './ListContextProvider';
+import { useIsAuthPending } from '../../auth';
+/**
+ * Call useListController and put the value in a ListContext
+ *
+ * Base class for <List> components, without UI.
+ *
+ * Accepts any props accepted by useListController:
+ * - filter: permanent filter applied to the list
+ * - filters: Filter element, to display the filters
+ * - filterDefaultValues: object;
+ * - perPage: Number of results per page
+ * - sort: Default sort
+ * - exporter: exported function
+ *
+ * @example // Custom list layout
+ *
+ * const PostList = () => (
+ *     <ListBase perPage={10}>
+ *         <div>
+ *              List metrics...
+ *         </div>
+ *         <Grid container>
+ *             <Grid item xs={8}>
+ *                 <SimpleList primaryText={record => record.title} />
+ *             </Grid>
+ *             <Grid item xs={4}>
+ *                 List instructions...
+ *             </Grid>
+ *         </Grid>
+ *         <div>
+ *             Post related links...
+ *         </div>
+ *     </ListBase>
+ * );
+ */
+export const ListBase = ({ children, emptyWhileLoading, authLoading, loading, offline, error, empty, render, ...props }) => {
+    const controllerProps = useListController(props);
+    const isAuthPending = useIsAuthPending({
+        resource: controllerProps.resource,
+        action: 'list',
+    });
+    if (!render && !children) {
+        throw new Error("<ListBase> requires either a 'render' prop or 'children' prop");
+    }
+    const { isPaused, isPending, isPlaceholderData, error: errorState, data, total, hasPreviousPage, hasNextPage, filterValues, } = controllerProps;
+    const showAuthLoading = isAuthPending &&
+        !props.disableAuthentication &&
+        authLoading !== false &&
+        authLoading !== undefined;
+    const showLoading = !isPaused &&
+        ((!props.disableAuthentication && isAuthPending) || isPending) &&
+        loading !== false &&
+        loading !== undefined;
+    const showOffline = isPaused &&
+        // If isPending and isPaused are true, we are offline and couldn't even load the initial data
+        // If isPaused and isPlaceholderData are true, we are offline and couldn't even load data with different parameters on the same useQuery observer
+        (isPending || isPlaceholderData) &&
+        offline !== false &&
+        offline !== undefined;
+    const showError = errorState && error !== false && error !== undefined;
+    const showEmptyWhileLoading = isPending && !showOffline && emptyWhileLoading === true;
+    const showEmpty = !errorState &&
+        // the list is not loading data for the first time
+        !isPending &&
+        // the API returned no data (using either normal or partial pagination)
+        (total === 0 ||
+            (total == null &&
+                hasPreviousPage === false &&
+                hasNextPage === false &&
+                // @ts-ignore FIXME total may be undefined when using partial pagination but the ListControllerResult type is wrong about it
+                data.length === 0)) &&
+        // the user didn't set any filters
+        !Object.keys(filterValues).length &&
+        // there is an empty page component
+        empty !== undefined &&
+        empty !== false;
+    return (
+    // We pass props.resource here as we don't need to create a new ResourceContext if the props is not provided
+    _jsx(OptionalResourceContextProvider, { value: props.resource, children: _jsx(ListContextProvider, { value: controllerProps, children: showAuthLoading
+                ? authLoading
+                : showLoading
+                    ? loading
+                    : showOffline
+                        ? offline
+                        : showError
+                            ? error
+                            : showEmptyWhileLoading
+                                ? null
+                                : showEmpty
+                                    ? empty
+                                    : render
+                                        ? render(controllerProps)
+                                        : children }) }));
+};

package/dist/ra-core/src/controller/list/ListContext.d.ts

@@ -0,0 +1,54 @@
+import { ListControllerResult } from './useListController';
+/**
+ * Context to store the result of the useListController() hook.
+ *
+ * Use the useListContext() hook to read the context. That's what many
+ * List components do in react-admin (e.g. <Datagrid>, <FilterForm>, <Pagination>).
+ *
+ * @typedef {Object} ListControllerProps
+ * @prop {Array}    data an array of the list records, e.g. [{ id: 123, title: 'hello world' }, { ... }]
+ * @prop {integer}  total the total number of results for the current filters, excluding pagination. Useful to build the pagination controls. e.g. 23
+ * @prop {boolean}  isFetching boolean that is true on mount, and false once the data was fetched
+ * @prop {boolean}  isLoading boolean that is false until the data is available
+ * @prop {integer}  page the current page. Starts at 1
+ * @prop {Function} setPage a callback to change the page, e.g. setPage(3)
+ * @prop {integer}  perPage the number of results per page. Defaults to 25
+ * @prop {Function} setPerPage a callback to change the number of results per page, e.g. setPerPage(25)
+ * @prop {Object}   sort a sort object { field, order }, e.g. { field: 'date', order: 'DESC' }
+ * @prop {Function} setSort a callback to change the sort, e.g. setSort({ field: 'name', order: 'ASC' })
+ * @prop {Object}   filterValues a dictionary of filter values, e.g. { title: 'lorem', nationality: 'fr' }
+ * @prop {Function} setFilters a callback to update the filters, e.g. setFilters(filters, displayedFilters)
+ * @prop {Object}   displayedFilters a dictionary of the displayed filters, e.g. { title: true, nationality: true }
+ * @prop {Function} showFilter a callback to show one of the filters, e.g. showFilter('title', defaultValue)
+ * @prop {Function} hideFilter a callback to hide one of the filters, e.g. hideFilter('title')
+ * @prop {Array}    selectedIds an array listing the ids of the selected rows, e.g. [123, 456]
+ * @prop {Function} onSelect callback to change the list of selected rows, e.g. onSelect([456, 789])
+ * @prop {Function} onSelectAll callback to select all the records, e.g. onSelectAll()
+ * @prop {Function} onToggleItem callback to toggle the selection of a given record based on its id, e.g. onToggleItem(456)
+ * @prop {Function} onUnselectItems callback to clear the selection, e.g. onUnselectItems();
+ * @prop {string}   defaultTitle the translated title based on the resource, e.g. 'Posts'
+ * @prop {string}   resource the resource name, deduced from the location. e.g. 'posts'
+ * @prop {Function} refetch a function for triggering a refetch of the list data
+ *
+ * @typedef Props
+ * @prop {ListControllerResult} value
+ *
+ * @param {Props}
+ *
+ * @see useListController
+ * @see useListContext
+ *
+ * @example
+ *
+ * import { useListController, ListContext } from '@strato-admin/ra-core';
+ *
+ * const List = props => {
+ *     const controllerProps = useListController(props);
+ *     return (
+ *         <ListContext.Provider value={controllerProps}>
+ *             ...
+ *         </ListContext.Provider>
+ *     );
+ * };
+ */
+export declare const ListContext: import("react").Context<ListControllerResult | null>;

package/dist/ra-core/src/controller/list/ListContext.js

@@ -0,0 +1,55 @@
+import { createContext } from 'react';
+/**
+ * Context to store the result of the useListController() hook.
+ *
+ * Use the useListContext() hook to read the context. That's what many
+ * List components do in react-admin (e.g. <Datagrid>, <FilterForm>, <Pagination>).
+ *
+ * @typedef {Object} ListControllerProps
+ * @prop {Array}    data an array of the list records, e.g. [{ id: 123, title: 'hello world' }, { ... }]
+ * @prop {integer}  total the total number of results for the current filters, excluding pagination. Useful to build the pagination controls. e.g. 23
+ * @prop {boolean}  isFetching boolean that is true on mount, and false once the data was fetched
+ * @prop {boolean}  isLoading boolean that is false until the data is available
+ * @prop {integer}  page the current page. Starts at 1
+ * @prop {Function} setPage a callback to change the page, e.g. setPage(3)
+ * @prop {integer}  perPage the number of results per page. Defaults to 25
+ * @prop {Function} setPerPage a callback to change the number of results per page, e.g. setPerPage(25)
+ * @prop {Object}   sort a sort object { field, order }, e.g. { field: 'date', order: 'DESC' }
+ * @prop {Function} setSort a callback to change the sort, e.g. setSort({ field: 'name', order: 'ASC' })
+ * @prop {Object}   filterValues a dictionary of filter values, e.g. { title: 'lorem', nationality: 'fr' }
+ * @prop {Function} setFilters a callback to update the filters, e.g. setFilters(filters, displayedFilters)
+ * @prop {Object}   displayedFilters a dictionary of the displayed filters, e.g. { title: true, nationality: true }
+ * @prop {Function} showFilter a callback to show one of the filters, e.g. showFilter('title', defaultValue)
+ * @prop {Function} hideFilter a callback to hide one of the filters, e.g. hideFilter('title')
+ * @prop {Array}    selectedIds an array listing the ids of the selected rows, e.g. [123, 456]
+ * @prop {Function} onSelect callback to change the list of selected rows, e.g. onSelect([456, 789])
+ * @prop {Function} onSelectAll callback to select all the records, e.g. onSelectAll()
+ * @prop {Function} onToggleItem callback to toggle the selection of a given record based on its id, e.g. onToggleItem(456)
+ * @prop {Function} onUnselectItems callback to clear the selection, e.g. onUnselectItems();
+ * @prop {string}   defaultTitle the translated title based on the resource, e.g. 'Posts'
+ * @prop {string}   resource the resource name, deduced from the location. e.g. 'posts'
+ * @prop {Function} refetch a function for triggering a refetch of the list data
+ *
+ * @typedef Props
+ * @prop {ListControllerResult} value
+ *
+ * @param {Props}
+ *
+ * @see useListController
+ * @see useListContext
+ *
+ * @example
+ *
+ * import { useListController, ListContext } from '@strato-admin/ra-core';
+ *
+ * const List = props => {
+ *     const controllerProps = useListController(props);
+ *     return (
+ *         <ListContext.Provider value={controllerProps}>
+ *             ...
+ *         </ListContext.Provider>
+ *     );
+ * };
+ */
+export const ListContext = createContext(null);
+ListContext.displayName = 'ListContext';

package/dist/ra-core/src/controller/list/ListContextProvider.d.ts

@@ -0,0 +1,33 @@
+import * as React from 'react';
+import { ListControllerResult } from './useListController';
+/**
+ * Create a List Context and several thematic List subcontext.
+ *
+ * Allows children to subscribe to part of the ListContext, and bail out of
+ * rendering when some parts of the context that they don't depend on change
+ * (because unfortunately React doesn't allow to use context selectors yet).
+ *
+ * @example
+ *
+ * const MyList = (props) => {
+ *     const controllerProps = useListController(props);
+ *     return (
+ *         <ListContextProvider value={controllerProps}>
+ *             <MyListView>
+ *         </ListContextProvider>
+ *     );
+ * };
+ *
+ * const MyListView = () => {
+ *     const { data, filterValues, setFilters } = useListContext();
+ *     // or, to rerender only when filters change but not data
+ *     const { filterValues, setFilters } = useListFilterContext();
+ * }
+ *
+ * @see ListContext
+ * @see ListFilterContext
+ */
+export declare const ListContextProvider: ({ value, children, }: {
+    value: ListControllerResult;
+    children: React.ReactNode;
+}) => import("react/jsx-runtime").JSX.Element;

package/dist/ra-core/src/controller/list/ListContextProvider.js

@@ -0,0 +1,33 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { ListContext } from './ListContext';
+import { ListFilterContext, usePickFilterContext } from './ListFilterContext';
+import { ListSortContext, usePickSortContext } from './ListSortContext';
+import { ListPaginationContext, usePickPaginationContext, } from './ListPaginationContext';
+/**
+ * Create a List Context and several thematic List subcontext.
+ *
+ * Allows children to subscribe to part of the ListContext, and bail out of
+ * rendering when some parts of the context that they don't depend on change
+ * (because unfortunately React doesn't allow to use context selectors yet).
+ *
+ * @example
+ *
+ * const MyList = (props) => {
+ *     const controllerProps = useListController(props);
+ *     return (
+ *         <ListContextProvider value={controllerProps}>
+ *             <MyListView>
+ *         </ListContextProvider>
+ *     );
+ * };
+ *
+ * const MyListView = () => {
+ *     const { data, filterValues, setFilters } = useListContext();
+ *     // or, to rerender only when filters change but not data
+ *     const { filterValues, setFilters } = useListFilterContext();
+ * }
+ *
+ * @see ListContext
+ * @see ListFilterContext
+ */
+export const ListContextProvider = ({ value, children, }) => (_jsx(ListContext.Provider, { value: value, children: _jsx(ListFilterContext.Provider, { value: usePickFilterContext(value), children: _jsx(ListSortContext.Provider, { value: usePickSortContext(value), children: _jsx(ListPaginationContext.Provider, { value: usePickPaginationContext(value), children: children }) }) }) }));

package/dist/ra-core/src/controller/list/ListController.d.ts

@@ -0,0 +1,19 @@
+import { ReactNode } from 'react';
+import { RaRecord } from '../../types';
+import { ListControllerProps, ListControllerResult } from './useListController';
+/**
+ * Render prop version of the useListController hook.
+ *
+ * @see useListController
+ * @example
+ *
+ * const ListView = () => <div>...</div>;
+ * const List = props => (
+ *     <ListController {...props}>
+ *        {controllerProps => <ListView {...controllerProps} {...props} />}
+ *     </ListController>
+ * )
+ */
+export declare const ListController: <RecordType extends RaRecord = any, ErrorType = Error>({ children, ...props }: {
+    children: (params: ListControllerResult<RecordType, ErrorType>) => ReactNode;
+} & ListControllerProps<RecordType, ErrorType>) => ReactNode;

package/dist/ra-core/src/controller/list/ListController.js

@@ -0,0 +1,18 @@
+import { useListController, } from './useListController';
+/**
+ * Render prop version of the useListController hook.
+ *
+ * @see useListController
+ * @example
+ *
+ * const ListView = () => <div>...</div>;
+ * const List = props => (
+ *     <ListController {...props}>
+ *        {controllerProps => <ListView {...controllerProps} {...props} />}
+ *     </ListController>
+ * )
+ */
+export const ListController = ({ children, ...props }) => {
+    const controllerProps = useListController(props);
+    return children(controllerProps);
+};

package/dist/ra-core/src/controller/list/ListFilterContext.d.ts

@@ -0,0 +1,39 @@
+import { ListControllerResult } from './useListController';
+/**
+ * Context to store the filter part of the useListController() result.
+ *
+ * Use the useListFilterContext() hook to read the context. That's what many
+ * List components do in react-admin (e.g. <FilterForm>, <FilterListItem>).
+ *
+ * @typedef {Object} ListFilterContextValue
+ * @prop {Object}   filterValues a dictionary of filter values, e.g. { title: 'lorem', nationality: 'fr' }
+ * @prop {Function} setFilters a callback to update the filters, e.g. setFilters(filters, displayedFilters)
+ * @prop {Object}   displayedFilters a dictionary of the displayed filters, e.g. { title: true, nationality: true }
+ * @prop {Function} showFilter a callback to show one of the filters, e.g. showFilter('title', defaultValue)
+ * @prop {Function} hideFilter a callback to hide one of the filters, e.g. hideFilter('title')
+ * @prop {string}   resource the resource name, deduced from the location. e.g. 'posts'
+ *
+ * @typedef Props
+ * @prop {ListFilterContextValue} value
+ *
+ * @param {Props}
+ *
+ * @see useListController
+ * @see useListFilterContext
+ *
+ * @example
+ *
+ * import { useListController, usePickFilterContext, ListFilterContext } from '@strato-admin/ra-core';
+ *
+ * const List = props => {
+ *     const controllerProps = useListController(props);
+ *     return (
+ *         <ListFilterContext.Provider value={usePickFilterContext(controllerProps)}>
+ *             ...
+ *         </ListFilterContext.Provider>
+ *     );
+ * };
+ */
+export declare const ListFilterContext: import("react").Context<ListFilterContextValue | undefined>;
+export type ListFilterContextValue = Pick<ListControllerResult, 'displayedFilters' | 'filterValues' | 'hideFilter' | 'setFilters' | 'showFilter' | 'resource'>;
+export declare const usePickFilterContext: (context: ListControllerResult) => ListFilterContextValue;

package/dist/ra-core/src/controller/list/ListFilterContext.js

@@ -0,0 +1,55 @@
+import { createContext, useMemo } from 'react';
+import pick from 'lodash/pick.js';
+/**
+ * Context to store the filter part of the useListController() result.
+ *
+ * Use the useListFilterContext() hook to read the context. That's what many
+ * List components do in react-admin (e.g. <FilterForm>, <FilterListItem>).
+ *
+ * @typedef {Object} ListFilterContextValue
+ * @prop {Object}   filterValues a dictionary of filter values, e.g. { title: 'lorem', nationality: 'fr' }
+ * @prop {Function} setFilters a callback to update the filters, e.g. setFilters(filters, displayedFilters)
+ * @prop {Object}   displayedFilters a dictionary of the displayed filters, e.g. { title: true, nationality: true }
+ * @prop {Function} showFilter a callback to show one of the filters, e.g. showFilter('title', defaultValue)
+ * @prop {Function} hideFilter a callback to hide one of the filters, e.g. hideFilter('title')
+ * @prop {string}   resource the resource name, deduced from the location. e.g. 'posts'
+ *
+ * @typedef Props
+ * @prop {ListFilterContextValue} value
+ *
+ * @param {Props}
+ *
+ * @see useListController
+ * @see useListFilterContext
+ *
+ * @example
+ *
+ * import { useListController, usePickFilterContext, ListFilterContext } from '@strato-admin/ra-core';
+ *
+ * const List = props => {
+ *     const controllerProps = useListController(props);
+ *     return (
+ *         <ListFilterContext.Provider value={usePickFilterContext(controllerProps)}>
+ *             ...
+ *         </ListFilterContext.Provider>
+ *     );
+ * };
+ */
+export const ListFilterContext = createContext(undefined);
+export const usePickFilterContext = (context) => useMemo(() => pick(context, [
+    'displayedFilters',
+    'filterValues',
+    'hideFilter',
+    'setFilters',
+    'showFilter',
+    'resource',
+]), 
+// eslint-disable-next-line react-hooks/exhaustive-deps
+[
+    context.displayedFilters,
+    context.filterValues,
+    context.hideFilter,
+    context.setFilters,
+    context.showFilter,
+]);
+ListFilterContext.displayName = 'ListFilterContext';

package/dist/ra-core/src/controller/list/ListPaginationContext.d.ts

@@ -0,0 +1,43 @@
+import { ListControllerResult } from './useListController';
+/**
+ * Context to store the pagination part of the useListController() result.
+ *
+ * Use the useListPaginationContext() hook to read the pagination information.
+ * That's what List components do in react-admin (e.g. <Pagination>).
+ *
+ * @typedef {Object} ListPaginationContextValue
+ * @prop {boolean}  isLoading boolean that is false until the data is available
+ * @prop {integer}  total the total number of results for the current filters, excluding pagination. Useful to build the pagination controls. e.g. 23
+ * @prop {integer}  page the current page. Starts at 1
+ * @prop {Function} setPage a callback to change the page, e.g. setPage(3)
+ * @prop {integer}  perPage the number of results per page. Defaults to 25
+ * @prop {Function} setPerPage a callback to change the number of results per page, e.g. setPerPage(25)
+ * @prop {Boolean}  hasPreviousPage true if the current page is not the first one
+ * @prop {Boolean}  hasNextPage true if the current page is not the last one
+
+ * @prop {string}   resource the resource name, deduced from the location. e.g. 'posts'
+ *
+ * @typedef Props
+ * @prop {ListPaginationContextValue} value
+ *
+ * @param {Props}
+ *
+ * @see useListController
+ * @see useListContext
+ *
+ * @example
+ *
+ * import { useListController, ListPaginationContext } from '@strato-admin/ra-core';
+ *
+ * const List = props => {
+ *     const controllerProps = useListController(props);
+ *     return (
+ *         <ListPaginationContext.Provider value={controllerProps}>
+ *             ...
+ *         </ListPaginationContext.Provider>
+ *     );
+ * };
+ */
+export declare const ListPaginationContext: import("react").Context<ListPaginationContextValue | undefined>;
+export type ListPaginationContextValue = Pick<ListControllerResult, 'isLoading' | 'isPending' | 'hasPreviousPage' | 'hasNextPage' | 'page' | 'perPage' | 'setPage' | 'setPerPage' | 'total' | 'resource'>;
+export declare const usePickPaginationContext: (context: ListControllerResult) => ListPaginationContextValue;

package/dist/ra-core/src/controller/list/ListPaginationContext.js

@@ -0,0 +1,67 @@
+import { createContext, useMemo } from 'react';
+import pick from 'lodash/pick.js';
+/**
+ * Context to store the pagination part of the useListController() result.
+ *
+ * Use the useListPaginationContext() hook to read the pagination information.
+ * That's what List components do in react-admin (e.g. <Pagination>).
+ *
+ * @typedef {Object} ListPaginationContextValue
+ * @prop {boolean}  isLoading boolean that is false until the data is available
+ * @prop {integer}  total the total number of results for the current filters, excluding pagination. Useful to build the pagination controls. e.g. 23
+ * @prop {integer}  page the current page. Starts at 1
+ * @prop {Function} setPage a callback to change the page, e.g. setPage(3)
+ * @prop {integer}  perPage the number of results per page. Defaults to 25
+ * @prop {Function} setPerPage a callback to change the number of results per page, e.g. setPerPage(25)
+ * @prop {Boolean}  hasPreviousPage true if the current page is not the first one
+ * @prop {Boolean}  hasNextPage true if the current page is not the last one
+
+ * @prop {string}   resource the resource name, deduced from the location. e.g. 'posts'
+ *
+ * @typedef Props
+ * @prop {ListPaginationContextValue} value
+ *
+ * @param {Props}
+ *
+ * @see useListController
+ * @see useListContext
+ *
+ * @example
+ *
+ * import { useListController, ListPaginationContext } from '@strato-admin/ra-core';
+ *
+ * const List = props => {
+ *     const controllerProps = useListController(props);
+ *     return (
+ *         <ListPaginationContext.Provider value={controllerProps}>
+ *             ...
+ *         </ListPaginationContext.Provider>
+ *     );
+ * };
+ */
+export const ListPaginationContext = createContext(undefined);
+ListPaginationContext.displayName = 'ListPaginationContext';
+export const usePickPaginationContext = (context) => useMemo(() => pick(context, [
+    'isLoading',
+    'isPending',
+    'hasPreviousPage',
+    'hasNextPage',
+    'page',
+    'perPage',
+    'setPage',
+    'setPerPage',
+    'total',
+    'resource',
+]), 
+// eslint-disable-next-line react-hooks/exhaustive-deps
+[
+    context.isLoading,
+    context.isPending,
+    context.hasPreviousPage,
+    context.hasNextPage,
+    context.page,
+    context.perPage,
+    context.setPage,
+    context.setPerPage,
+    context.total,
+]);

package/dist/ra-core/src/controller/list/ListSortContext.d.ts

@@ -0,0 +1,36 @@
+import { ListControllerResult } from './useListController';
+/**
+ * Context to store the sort part of the useListController() result.
+ *
+ * Use the useListSortContext() hook to read the context. That's what many
+ * List components do in react-admin (e.g. <SortButton>).
+ *
+ * @typedef {Object} ListSortContextValue
+ * @prop {Object}   sort a sort object { field, order }, e.g. { field: 'date', order: 'DESC' }
+ * @prop {Function} setSort a callback to change the sort, e.g. setSort({ field: 'name', order: 'ASC' })
+ * @prop {string}   resource the resource name, deduced from the location. e.g. 'posts'
+ *
+ * @typedef Props
+ * @prop {ListSortContextValue} value
+ *
+ * @param {Props}
+ *
+ * @see useListController
+ * @see useListSortContext
+ *
+ * @example
+ *
+ * import { useListController, usePickSortContext, ListSortContext } from '@strato-admin/ra-core';
+ *
+ * const List = props => {
+ *     const controllerProps = useListController(props);
+ *     return (
+ *         <ListSortContext.Provider value={usePickSortContext(controllerProps)}>
+ *             ...
+ *         </ListSortContext.Provider>
+ *     );
+ * };
+ */
+export declare const ListSortContext: import("react").Context<ListSortContextValue | undefined>;
+export type ListSortContextValue = Pick<ListControllerResult, 'sort' | 'setSort' | 'resource'>;
+export declare const usePickSortContext: (context: ListControllerResult) => ListSortContextValue;

package/dist/ra-core/src/controller/list/ListSortContext.js

@@ -0,0 +1,39 @@
+import { createContext, useMemo } from 'react';
+import pick from 'lodash/pick.js';
+/**
+ * Context to store the sort part of the useListController() result.
+ *
+ * Use the useListSortContext() hook to read the context. That's what many
+ * List components do in react-admin (e.g. <SortButton>).
+ *
+ * @typedef {Object} ListSortContextValue
+ * @prop {Object}   sort a sort object { field, order }, e.g. { field: 'date', order: 'DESC' }
+ * @prop {Function} setSort a callback to change the sort, e.g. setSort({ field: 'name', order: 'ASC' })
+ * @prop {string}   resource the resource name, deduced from the location. e.g. 'posts'
+ *
+ * @typedef Props
+ * @prop {ListSortContextValue} value
+ *
+ * @param {Props}
+ *
+ * @see useListController
+ * @see useListSortContext
+ *
+ * @example
+ *
+ * import { useListController, usePickSortContext, ListSortContext } from '@strato-admin/ra-core';
+ *
+ * const List = props => {
+ *     const controllerProps = useListController(props);
+ *     return (
+ *         <ListSortContext.Provider value={usePickSortContext(controllerProps)}>
+ *             ...
+ *         </ListSortContext.Provider>
+ *     );
+ * };
+ */
+export const ListSortContext = createContext(undefined);
+export const usePickSortContext = (context) => useMemo(() => pick(context, ['sort', 'setSort', 'resource']), 
+// eslint-disable-next-line react-hooks/exhaustive-deps
+[context.sort, context.setSort]);
+ListSortContext.displayName = 'ListSortContext';

package/dist/ra-core/src/controller/list/RecordsIterator.d.ts

@@ -0,0 +1,16 @@
+import * as React from 'react';
+import { RaRecord } from '../../types';
+import { ListControllerSuccessResult } from './useListController';
+export declare const RecordsIterator: <RecordType extends RaRecord = any>(props: RecordsIteratorProps<RecordType>) => import("react/jsx-runtime").JSX.Element | null;
+export interface RecordsIteratorProps<RecordType extends RaRecord = any> extends Partial<ListControllerSuccessResult<RecordType>> {
+    children?: React.ReactNode;
+    render?: (record: RecordType, index: number) => React.ReactNode;
+}
+/**
+ * @deprecated use RecordsIterator instead.
+ */
+export declare const ListIterator: <RecordType extends RaRecord = any>(props: RecordsIteratorProps<RecordType>) => import("react/jsx-runtime").JSX.Element | null;
+/**
+ * @deprecated use RecordsIteratorProps instead.
+ */
+export type ListIteratorProps = RecordsIteratorProps;