ra-core/src/export/useBulkExport.ts

Core components of react-admin, a frontend Framework for building admin applications on top of REST services, using ES6, React

import { useCallback } from 'react';
import { Exporter, RaRecord } from '../types';
import { useResourceContext } from '../core/useResourceContext';
import { useListContext } from '../controller/list/useListContext';
import { useDataProvider } from '../dataProvider/useDataProvider';
import { useNotify } from '../notification/useNotify';
import { fetchRelatedRecords } from './fetchRelatedRecords';

/**
 * A hook that provides a callback to export the selected records from the nearest ListContext and call the exporter function for them.
 */
export function useBulkExport<RecordType extends RaRecord = any>(
    options: UseBulkExportOptions<RecordType> = {}
): UseBulkExportResult {
    const { exporter: customExporter, meta } = options;

    const resource = useResourceContext(options);
    const { exporter: exporterFromContext, selectedIds } =
        useListContext<RecordType>();
    const exporter = customExporter || exporterFromContext;
    const dataProvider = useDataProvider();
    const notify = useNotify();

    return useCallback(() => {
        if (exporter && resource) {
            dataProvider
                .getMany(resource, { ids: selectedIds, meta })
                .then(({ data }) =>
                    exporter(
                        data,
                        fetchRelatedRecords(dataProvider),
                        dataProvider,
                        resource
                    )
                )
                .catch(error => {
                    console.error(error);
                    notify('ra.notification.http_error', {
                        type: 'error',
                    });
                });
        }
    }, [dataProvider, exporter, notify, resource, selectedIds, meta]);
}

export type UseBulkExportResult = () => void;

export interface UseBulkExportOptions<RecordType extends RaRecord = any> {
    exporter?: Exporter<RecordType>;
    meta?: any;
    resource?: string;
}