@strato-admin/faker-ecommerce 0.1.1 → 0.3.0

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

@@ -0,0 +1,11 @@
+export * from './DataTableBase';
+export * from './DataTableCallbacksContext';
+export * from './DataTableColumnRankContext';
+export * from './DataTableColumnFilterContext';
+export * from './DataTableConfigContext';
+export * from './DataTableDataContext';
+export * from './DataTableRenderContext';
+export * from './DataTableSelectedIdsContext';
+export * from './DataTableSortContext';
+export * from './DataTableStoreContext';
+export * from './types';

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

@@ -0,0 +1,11 @@
+export * from './DataTableBase';
+export * from './DataTableCallbacksContext';
+export * from './DataTableColumnRankContext';
+export * from './DataTableColumnFilterContext';
+export * from './DataTableConfigContext';
+export * from './DataTableDataContext';
+export * from './DataTableRenderContext';
+export * from './DataTableSelectedIdsContext';
+export * from './DataTableSortContext';
+export * from './DataTableStoreContext';
+export * from './types';

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

@@ -0,0 +1,2 @@
+import { Identifier, RaRecord } from '../types';
+export type RowClickFunctionBase<RecordType extends RaRecord = RaRecord> = (id: Identifier, resource: string, record: RecordType) => string | false | Promise<string | false>;

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

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

package/dist/ra-core/src/export/ExporterContext.d.ts

@@ -0,0 +1,2 @@
+import { Exporter } from '../types';
+export declare const ExporterContext: import("react").Context<false | Exporter>;

package/dist/ra-core/src/export/ExporterContext.js

@@ -0,0 +1,4 @@
+import { createContext } from 'react';
+import { defaultExporter } from './defaultExporter';
+export const ExporterContext = createContext(defaultExporter);
+ExporterContext.displayName = 'ExporterContext';

package/dist/ra-core/src/export/defaultExporter.d.ts

@@ -0,0 +1,2 @@
+import { Exporter } from '../types';
+export declare const defaultExporter: Exporter;

package/dist/ra-core/src/export/defaultExporter.js

@@ -0,0 +1,3 @@
+import jsonExport from 'jsonexport/dist/index.js';
+import { downloadCSV } from './downloadCSV';
+export const defaultExporter = (data, _, __, resource) => jsonExport(data, (err, csv) => downloadCSV(csv, resource));

package/dist/ra-core/src/export/downloadCSV.d.ts

@@ -0,0 +1 @@
+export declare const downloadCSV: (csv: string, filename?: string) => void;

package/dist/ra-core/src/export/downloadCSV.js

@@ -0,0 +1,17 @@
+export const downloadCSV = (csv, filename = 'export') => {
+    const fakeLink = document.createElement('a');
+    fakeLink.style.display = 'none';
+    document.body.appendChild(fakeLink);
+    const blob = new Blob([csv], { type: 'text/csv;charset=utf-8' });
+    // @ts-ignore
+    if (window.navigator && window.navigator.msSaveOrOpenBlob) {
+        // Manage IE11+ & Edge
+        // @ts-ignore
+        window.navigator.msSaveOrOpenBlob(blob, `${filename}.csv`);
+    }
+    else {
+        fakeLink.setAttribute('href', URL.createObjectURL(blob));
+        fakeLink.setAttribute('download', `${filename}.csv`);
+        fakeLink.click();
+    }
+};

package/dist/ra-core/src/export/fetchRelatedRecords.d.ts

@@ -0,0 +1,14 @@
+import { DataProvider, FetchRelatedRecords } from '../types';
+/**
+ * Helper function for calling the dataProvider.getMany() method,
+ * and getting a Promise for the records indexed by id in return.
+ *
+ * @example
+ *     fetchRelatedRecords(dataProvider)(records, 'post_id', 'posts').then(posts =>
+ *         posts.map(record => ({
+ *             ...record,
+ *             post_title: posts[record.post_id].title,
+ *         }))
+ *     );
+ */
+export declare const fetchRelatedRecords: (dataProvider: DataProvider) => FetchRelatedRecords;

package/dist/ra-core/src/export/fetchRelatedRecords.js

@@ -0,0 +1,19 @@
+import { getRelatedIds } from './getRelatedIds';
+/**
+ * Helper function for calling the dataProvider.getMany() method,
+ * and getting a Promise for the records indexed by id in return.
+ *
+ * @example
+ *     fetchRelatedRecords(dataProvider)(records, 'post_id', 'posts').then(posts =>
+ *         posts.map(record => ({
+ *             ...record,
+ *             post_title: posts[record.post_id].title,
+ *         }))
+ *     );
+ */
+export const fetchRelatedRecords = (dataProvider) => (data, field, resource) => dataProvider
+    .getMany(resource, { ids: getRelatedIds(data, field) })
+    .then(({ data }) => data.reduce((acc, post) => {
+    acc[post.id] = post;
+    return acc;
+}, {}));

package/dist/ra-core/src/export/getRelatedIds.d.ts

@@ -0,0 +1,24 @@
+import { RaRecord, Identifier } from '../types';
+/**
+ * Extracts, aggregates and deduplicates the ids of related records
+ *
+ * @example
+ *     const books = [
+ *         { id: 1, author_id: 123, title: 'Pride and Prejudice' },
+ *         { id: 2, author_id: 123, title: 'Sense and Sensibility' },
+ *         { id: 3, author_id: 456, title: 'War and Peace' },
+ *     ];
+ *     getRelatedIds(books, 'author_id'); => [123, 456]
+ *
+ * @example
+ *     const books = [
+ *         { id: 1, tag_ids: [1, 2], title: 'Pride and Prejudice' },
+ *         { id: 2, tag_ids: [2, 3], title: 'Sense and Sensibility' },
+ *         { id: 3, tag_ids: [4], title: 'War and Peace' },
+ *     ];
+ *     getRelatedIds(records, 'tag_ids'); => [1, 2, 3, 4]
+ *
+ * @param {Object[]} records An array of records
+ * @param {string} field the identifier of the record field to use
+ */
+export declare const getRelatedIds: (records: RaRecord[], field: string) => Identifier[];

package/dist/ra-core/src/export/getRelatedIds.js

@@ -0,0 +1,26 @@
+/**
+ * Extracts, aggregates and deduplicates the ids of related records
+ *
+ * @example
+ *     const books = [
+ *         { id: 1, author_id: 123, title: 'Pride and Prejudice' },
+ *         { id: 2, author_id: 123, title: 'Sense and Sensibility' },
+ *         { id: 3, author_id: 456, title: 'War and Peace' },
+ *     ];
+ *     getRelatedIds(books, 'author_id'); => [123, 456]
+ *
+ * @example
+ *     const books = [
+ *         { id: 1, tag_ids: [1, 2], title: 'Pride and Prejudice' },
+ *         { id: 2, tag_ids: [2, 3], title: 'Sense and Sensibility' },
+ *         { id: 3, tag_ids: [4], title: 'War and Peace' },
+ *     ];
+ *     getRelatedIds(records, 'tag_ids'); => [1, 2, 3, 4]
+ *
+ * @param {Object[]} records An array of records
+ * @param {string} field the identifier of the record field to use
+ */
+export const getRelatedIds = (records, field) => Array.from(new Set(records
+    .filter(record => record[field] != null)
+    .map(record => record[field])
+    .reduce((ids, value) => ids.concat(value), [])));

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

@@ -0,0 +1,5 @@
+export * from './defaultExporter';
+export * from './downloadCSV';
+export * from './ExporterContext';
+export * from './fetchRelatedRecords';
+export * from './useBulkExport';

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

@@ -0,0 +1,5 @@
+export * from './defaultExporter';
+export * from './downloadCSV';
+export * from './ExporterContext';
+export * from './fetchRelatedRecords';
+export * from './useBulkExport';

package/dist/ra-core/src/export/useBulkExport.d.ts

@@ -0,0 +1,11 @@
+import { Exporter, RaRecord } from '../types';
+/**
+ * A hook that provides a callback to export the selected records from the nearest ListContext and call the exporter function for them.
+ */
+export declare function useBulkExport<RecordType extends RaRecord = any>(options?: UseBulkExportOptions<RecordType>): UseBulkExportResult;
+export type UseBulkExportResult = () => void;
+export interface UseBulkExportOptions<RecordType extends RaRecord = any> {
+    exporter?: Exporter<RecordType>;
+    meta?: any;
+    resource?: string;
+}

package/dist/ra-core/src/export/useBulkExport.js

@@ -0,0 +1,30 @@
+import { useCallback } from 'react';
+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(options = {}) {
+    const { exporter: customExporter, meta } = options;
+    const resource = useResourceContext(options);
+    const { exporter: exporterFromContext, selectedIds } = useListContext();
+    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("strato.notification.http_error', {
+                    type: 'error',
+                });
+            });
+        }
+    }, [dataProvider, exporter, notify, resource, selectedIds, meta]);
+}

package/dist/ra-core/src/form/WarnWhenUnsavedChanges.d.ts

@@ -0,0 +1,5 @@
+export declare const WarnWhenUnsavedChanges: ({ enable, formRootPathName, formControl, }: {
+    enable?: boolean | undefined;
+    formRootPathName: any;
+    formControl: any;
+}) => null;

package/dist/ra-core/src/form/WarnWhenUnsavedChanges.js

@@ -0,0 +1,5 @@
+import { useWarnWhenUnsavedChanges } from './useWarnWhenUnsavedChanges';
+export const WarnWhenUnsavedChanges = ({ enable = true, formRootPathName, formControl, }) => {
+    useWarnWhenUnsavedChanges(enable, formRootPathName, formControl);
+    return null;
+};

package/dist/ra-core/src/form/choices/ChoicesContext.d.ts

@@ -0,0 +1,65 @@
+import { UseGetListHookValue } from '../../dataProvider/useGetList';
+import { FilterPayload, RaRecord, SortPayload } from '../../types';
+/**
+ * Context to store choices and functions to retrieve them.
+ *
+ * Use the useChoicesContext() hook to read the context.
+ */
+export declare const ChoicesContext: import("react").Context<ChoicesContextValue<any> | undefined>;
+export type ChoicesContextBaseValue<RecordType extends RaRecord = any> = {
+    displayedFilters: any;
+    filter?: FilterPayload;
+    filterValues: any;
+    hasNextPage?: boolean;
+    hasPreviousPage?: boolean;
+    hideFilter: (filterName: string) => void;
+    isFetching: boolean;
+    isLoading: boolean;
+    isPaused?: boolean;
+    isPlaceholderData?: boolean;
+    page: number;
+    perPage: number;
+    refetch: (() => void) | UseGetListHookValue<RecordType>['refetch'];
+    resource: string;
+    setFilters: (filters: any, displayedFilters?: any, debounce?: boolean) => void;
+    setPage: (page: number) => void;
+    setPerPage: (page: number) => void;
+    setSort: (sort: SortPayload) => void;
+    showFilter: (filterName: string, defaultValue: any) => void;
+    sort: SortPayload;
+    source: string;
+    isFromReference: boolean;
+};
+export interface ChoicesContextLoadingResult<RecordType extends RaRecord = any> extends ChoicesContextBaseValue<RecordType> {
+    allChoices: undefined;
+    availableChoices: undefined;
+    selectedChoices: undefined;
+    total: undefined;
+    error: null;
+    isPending: true;
+}
+export interface ChoicesContextErrorResult<RecordType extends RaRecord = any, TError = Error> extends ChoicesContextBaseValue<RecordType> {
+    allChoices: undefined;
+    availableChoices: undefined;
+    selectedChoices: undefined;
+    total: undefined;
+    error: TError;
+    isPending: false;
+}
+export interface ChoicesContextRefetchErrorResult<RecordType extends RaRecord = any, TError = Error> extends ChoicesContextBaseValue<RecordType> {
+    allChoices: RecordType[];
+    availableChoices: RecordType[];
+    selectedChoices: RecordType[];
+    total: number;
+    error: TError;
+    isPending: false;
+}
+export interface ChoicesContextSuccessResult<RecordType extends RaRecord = any> extends ChoicesContextBaseValue<RecordType> {
+    allChoices: RecordType[];
+    availableChoices: RecordType[];
+    selectedChoices: RecordType[];
+    total: number;
+    error: null;
+    isPending: false;
+}
+export type ChoicesContextValue<RecordType extends RaRecord = any> = ChoicesContextLoadingResult<RecordType> | ChoicesContextErrorResult<RecordType> | ChoicesContextRefetchErrorResult<RecordType> | ChoicesContextSuccessResult<RecordType>;

package/dist/ra-core/src/form/choices/ChoicesContext.js

@@ -0,0 +1,7 @@
+import { createContext } from 'react';
+/**
+ * Context to store choices and functions to retrieve them.
+ *
+ * Use the useChoicesContext() hook to read the context.
+ */
+export const ChoicesContext = createContext(undefined);

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

@@ -0,0 +1,4 @@
+export * from './ChoicesContext';
+export * from './ChoicesContextProvider';
+export * from './useChoicesContext';
+export * from './useChoices';

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

@@ -0,0 +1,4 @@
+export * from './ChoicesContext';
+export * from './ChoicesContextProvider';
+export * from './useChoicesContext';
+export * from './useChoices';

package/dist/ra-core/src/form/choices/useChoicesContext.d.ts

@@ -0,0 +1,5 @@
+import { RaRecord } from '../../types';
+import { ChoicesContextValue } from './ChoicesContext';
+export declare const useChoicesContext: <ChoicesType extends RaRecord = RaRecord>(options?: Partial<ChoicesContextValue> & {
+    choices?: ChoicesType[];
+}) => ChoicesContextValue<ChoicesType>;

package/dist/ra-core/src/form/choices/useChoicesContext.js

@@ -0,0 +1,62 @@
+import { useContext, useMemo } from 'react';
+import { useList } from '../../controller';
+import { ChoicesContext } from './ChoicesContext';
+export const useChoicesContext = (options = {}) => {
+    const context = useContext(ChoicesContext);
+    const choices = options.choices && isArrayOfStrings(options.choices)
+        ? convertOptionsToChoices(options.choices)
+        : options.choices;
+    // @ts-ignore cannot satisfy the type of useList because of ability to pass partial options
+    const { data, ...list } = useList({
+        data: choices,
+        isLoading: options.isLoading ?? false,
+        isPending: options.isPending ?? false,
+        isFetching: options.isFetching ?? false,
+        error: options.error,
+        // When not in a ChoicesContext, paginating does not make sense (e.g. AutocompleteInput).
+        perPage: Infinity,
+    });
+    const result = useMemo(() => {
+        // Props take precedence over context.
+        if (options.choices || !context) {
+            return {
+                allChoices: data,
+                availableChoices: options.availableChoices ?? data,
+                selectedChoices: options.selectedChoices ?? data,
+                displayedFilters: options.selectedChoices ?? list.displayedFilters,
+                error: options.error,
+                filter: options.filter ?? list.filter,
+                filterValues: options.filterValues ?? list.filterValues,
+                hasNextPage: options.hasNextPage ?? list.hasNextPage,
+                hasPreviousPage: options.hasPreviousPage ?? list.hasPreviousPage,
+                hideFilter: options.hideFilter ?? list.hideFilter,
+                isFetching: list.isFetching ?? false, // we must take the one for useList, otherwise the loading state isn't synchronized with the data
+                isLoading: list.isLoading ?? false, // same
+                isPaused: list.isPaused ?? false, // same
+                isPending: list.isPending ?? false, // same
+                isPlaceholderData: list.isPlaceholderData ?? false, // same
+                page: options.page ?? list.page,
+                perPage: options.perPage ?? list.perPage,
+                refetch: options.refetch ?? list.refetch,
+                resource: options.resource ?? list.resource,
+                setFilters: options.setFilters ?? list.setFilters,
+                setPage: options.setPage ?? list.setPage,
+                setPerPage: options.setPerPage ?? list.setPerPage,
+                setSort: options.setSort ?? list.setSort,
+                showFilter: options.showFilter ?? list.showFilter,
+                sort: options.sort ?? list.sort,
+                source: options.source,
+                total: options.total ?? list.total,
+                isFromReference: false,
+            };
+        }
+        return context;
+    }, [context, data, list, options]);
+    return result;
+};
+const isArrayOfStrings = (choices) => Array.isArray(choices) &&
+    choices.every(choice => typeof choice === 'string');
+const convertOptionsToChoices = (options) => options.map(choice => ({
+    id: choice,
+    name: choice,
+}));

package/dist/ra-core/src/form/getFormInitialValues.d.ts

@@ -0,0 +1,8 @@
+import { RaRecord } from '../types';
+export default function getFormInitialValues(defaultValues: DefaultValue, record?: Partial<RaRecord>): any;
+interface DefaultValueObject {
+    [key: string]: any;
+}
+type DefaultValueFunction = (record: RaRecord) => DefaultValueObject;
+type DefaultValue = DefaultValueObject | DefaultValueFunction;
+export {};

package/dist/ra-core/src/form/getFormInitialValues.js

@@ -0,0 +1,14 @@
+import merge from 'lodash/merge.js';
+export default function getFormInitialValues(defaultValues, record) {
+    const finalInitialValues = merge({}, getValues(defaultValues, record), record);
+    return finalInitialValues;
+}
+function getValues(values, record) {
+    if (typeof values === 'object') {
+        return values;
+    }
+    if (typeof values === 'function') {
+        return values(record);
+    }
+    return {};
+}

package/dist/ra-core/src/form/groups/FormGroupContext.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Context allowing inputs to register to a specific group.
+ * This enables other components in the group to access group properties such as its
+ * validation (valid/invalid) or whether its inputs have been updated (dirty/pristine).
+ *
+ * This should only be used through a FormGroupContextProvider.
+ */
+export declare const FormGroupContext: import("react").Context<string | null>;
+export type FormGroupContextValue = string;

package/dist/ra-core/src/form/groups/FormGroupContext.js

@@ -0,0 +1,9 @@
+import { createContext } from 'react';
+/**
+ * Context allowing inputs to register to a specific group.
+ * This enables other components in the group to access group properties such as its
+ * validation (valid/invalid) or whether its inputs have been updated (dirty/pristine).
+ *
+ * This should only be used through a FormGroupContextProvider.
+ */
+export const FormGroupContext = createContext(null);

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

@@ -0,0 +1,6 @@
+export * from './FormGroupContext';
+export * from './FormGroupContextProvider';
+export * from './FormGroupsProvider';
+export * from './useFormGroup';
+export * from './useFormGroups';
+export * from './useFormGroupContext';

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

@@ -0,0 +1,6 @@
+export * from './FormGroupContext';
+export * from './FormGroupContextProvider';
+export * from './FormGroupsProvider';
+export * from './useFormGroup';
+export * from './useFormGroups';
+export * from './useFormGroupContext';

package/dist/ra-core/src/form/groups/useFormGroup.d.ts

@@ -0,0 +1,67 @@
+type FieldState = {
+    name: string;
+    error?: any;
+    isDirty: boolean;
+    isTouched: boolean;
+    isValid: boolean;
+    isValidating: boolean;
+};
+type FormGroupState = {
+    errors?: object;
+    isDirty: boolean;
+    isTouched: boolean;
+    isValid: boolean;
+    isValidating: boolean;
+};
+/**
+ * Retrieve a specific form group data such as its validation status (valid/invalid) or
+ * or whether its inputs have been updated (dirty/pristine)
+ *
+ * @example
+ * import { Edit, SimpleForm, TextInput, FormGroupContextProvider, useFormGroup, minLength } from 'react-admin';
+ * import { Accordion, AccordionDetails, AccordionSummary, Typography } from '@mui/material';
+ * import ExpandMoreIcon from '@mui/icons-material/ExpandMoreIcon';
+ *
+ * const PostEdit = () => (
+ *     <Edit>
+ *         <SimpleForm>
+ *             <TextInput source="title" />
+ *             <FormGroupContextProvider name="options">
+ *                 <Accordion>
+ *                     <AccordionSummary
+ *                         expandIcon={<ExpandMoreIcon />}
+ *                         aria-controls="options-content"
+ *                         id="options-header"
+ *                     >
+ *                         <AccordionSectionTitle name="options">Options</AccordionSectionTitle>
+ *                     </AccordionSummary>
+ *                     <AccordionDetails id="options-content" aria-labelledby="options-header">
+ *                         <TextInput source="teaser" validate={minLength(20)} />
+ *                     </AccordionDetails>
+ *                 </Accordion>
+ *             </FormGroupContextProvider>
+ *         </SimpleForm>
+ *     </Edit>
+ * );
+ *
+ * const AccordionSectionTitle = ({ children, name }) => {
+ *     const formGroupState = useFormGroup(name);
+ *     return (
+ *         <Typography color={!formGroupState.isValid && formGroupState.isDirty ? 'error' : 'inherit'}>
+ *             {children}
+ *         </Typography>
+ *     );
+ * }
+ *
+ * @param {string} name The form group name
+ * @returns {FormGroupState} The form group state
+ */
+export declare const useFormGroup: (name: string) => FormGroupState;
+/**
+ * Get the state of a form group
+ *
+ * @param {FieldState[]} fieldStates A map of field states from react-hook-form where the key is the field name.
+ * @returns {FormGroupState} The state of the group.
+ */
+export declare const getFormGroupState: (fieldStates: FieldState[]) => FormGroupState;
+export {};