@steroidsjs/core 2.3.0-beta.1 → 2.3.0-beta.3

package/src/hooks/useList.tsx

@@ -1,494 +0,0 @@
-import {useCallback, useMemo} from 'react';
-import _get from 'lodash-es/get';
-import _union from 'lodash-es/union';
-import _isEqual from 'lodash-es/isEqual';
-import * as React from 'react';
-import {useMount, usePrevious, useUnmount, useUpdateEffect} from 'react-use';
-import {IApiMethod} from '../components/ApiComponent';
-import useSelector from '../hooks/useSelector';
-import {getList} from '../reducers/list';
-import useModel from '../hooks/useModel';
-import useAddressBar, {IAddressBarConfig} from '../hooks/useAddressBar';
-import {IList, listDestroy, listFetch, listInit, listLazyFetch, listSetItems} from '../actions/list';
-import useDispatch from '../hooks/useDispatch';
-import {formChange} from '../actions/form';
-import {formSelector} from '../reducers/form';
-import {ILayoutNamesProps, normalizeLayoutNamesProps} from '../ui/list/LayoutNames/LayoutNames';
-import useInitial from '../hooks/useInitial';
-import {IPaginationProps, normalizePaginationProps} from '../ui/list/Pagination/Pagination';
-import {IPaginationSizeProps, normalizePaginationSizeProps} from '../ui/list/PaginationSize/PaginationSize';
-import {IEmptyProps, normalizeEmptyProps} from '../ui/list/Empty/Empty';
-import {IFormProps} from '../ui/form/Form/Form';
-import {Model} from '../components/MetaComponent';
-
-export type ListControlPosition = 'top' | 'bottom' | 'both' | string;
-
-interface ISortProps {
-    /**
-     * Включить сортировку
-     * @example false
-     */
-    enable?: boolean,
-
-    /**
-     * Аттрибут (название) поля сортировки в форме
-     * @example sort
-     */
-    attribute?: string,
-
-    /**
-     * Значение сортировки по умолчанию. Нужно указать название свойства, по которому items будут сортироваться,
-     * а с помощью знака "-" задать тип сортировки (со знаком минус - сортировать по убыванию, иначе по возрастанию).
-     * @example -price
-     */
-    defaultValue?: string | string[] | null,
-}
-
-export interface IListConfig {
-    /**
-     * Идентификатор списка
-     * @example ArticlesList
-     */
-    listId?: string,
-
-    /**
-     * Первичный ключ для item
-     * @example id
-     */
-    primaryKey?: string,
-
-    /**
-     * Url, который вернет коллекцию элементов
-     * @example api/v1/articles
-     */
-    action?: string | IApiMethod,
-
-    /**
-     * Тип HTTP запроса (GET | POST | PUT | DELETE)
-     * @example GET
-     */
-    actionMethod?: HttpMethod,
-
-    /**
-     * Подключение пагинации
-     * @example {loadMore: true}
-     */
-    pagination?: boolean | IPaginationProps,
-
-    /**
-     * Переключение количества элементов в списке
-     * @example {sizes: [3, 6, 9], defaultValue: 3}
-     */
-    paginationSize?: boolean | IPaginationSizeProps,
-
-    /**
-     * Подключение сортировки
-     * @example {enable: true, defaultSort: 'startDate'}
-     */
-    sort?: boolean | ISortProps,
-
-    /**
-     * Варианты расположения элементов коллекции
-     * @example {items: [{id: 'list', label: 'List'}, {id: 'grid', label: 'Grid'}]}
-     */
-    layout?: boolean | ILayoutNamesProps,
-
-    /**
-     * Заглушка в случае отсутствия элементов
-     * @example {text: 'Записи не найдены'}
-     */
-    empty?: boolean | string | IEmptyProps,
-
-    /**
-     * Форма для поиска элементов
-     * @example {fields: ['title'], model: {attributes: ['title:string:Название']}}
-     */
-    searchForm?: Omit<IFormProps, 'formId'> & {
-        formId?: string,
-    },
-
-    /**
-     * Удаление данных списка из хранилища Redux при размонтировании компонента
-     * @example true
-     */
-    autoDestroy?: boolean,
-
-    /**
-     * Отправлять запрос на обновление данных при изменении данных формы. По-умолчанию - включено.
-     * @example false
-     */
-    autoFetchOnFormChanges?: boolean,
-
-    /**
-     * Обработчик, который вызывается при изменении значений формы, и нужен для подгрузки новых элементов коллекции
-     * @param {IList} list
-     * @param {Object} query
-     * @param {*} http
-     * @return {Promise}
-     */
-    onFetch?: (list: IList, query: Record<string, unknown>, http: any) => Promise<any>,
-
-    /**
-     * Обработчик, который составляет список условий для локальной фильтрации элементов коллекции
-     * @param {Object} query
-     * @return {Array} ['>=', 'age', 18]
-     */
-    condition?: (query: Record<string, unknown>) => any[],
-
-    /**
-     * Синхронизация значений формы списка с адресной строкой
-     * @example true
-     */
-    addressBar?: boolean | IAddressBarConfig,
-
-    scope?: string[],
-
-    /**
-     * Дополнительные параметры, значения которых нужно передавать в запросе для получения данных
-     * @example {tagName: 'MarketReviews'}
-     */
-    query?: Record<string, unknown>,
-
-    model?: string,
-
-    /**
-     * Модель для синхронизации значений формы с адресной строкой
-     * @example {attributes: [{attribute: 'isMilesAvailable', type: boolean}]}
-     */
-    searchModel?: string,
-
-    /**
-     * Элементы коллекции
-     */
-    items?: Array<any>,
-
-    /**
-     * Начальные элементы. Используется для подгрузки нескольких списков в один запрос, при этом не отменяя пагинацию
-     * и последующие запросы на бекенд для 2-й и следующих страниц
-     */
-    initialItems?: Array<any>,
-
-    /**
-     * Количество элементов всего в списке (для отрисовки пагинации), заданное вручную
-     */
-    initialTotal?: number,
-}
-
-export interface IListOutput {
-    list: IList,
-    model: Model,
-    searchModel: Model,
-    paginationPosition: ListControlPosition,
-    paginationSizePosition: ListControlPosition,
-    layoutNamesPosition: ListControlPosition,
-    renderList: (children: any) => any,
-    renderEmpty: () => any,
-    renderPagination: () => any,
-    renderPaginationSize: () => any,
-    renderLayoutNames: () => any,
-    renderSearchForm: () => any,
-    onFetch: (params?: Record<string, unknown>) => void,
-    onSort: (value: any) => void,
-}
-
-export const defaultConfig = {
-    actionMethod: 'get',
-    primaryKey: 'id',
-    autoDestroy: true,
-    sort: {
-        enable: false,
-        attribute: 'sort',
-        defaultValue: null,
-    },
-};
-
-export const normalizeSortProps = (props: IListConfig['sort']) => ({
-    ...defaultConfig.sort,
-    enable: !!props,
-    ...(typeof props === 'boolean' ? {enable: props} : props),
-});
-
-export const getDefaultSearchModel = ({
-    paginationProps,
-    paginationSizeProps,
-    sort,
-    layoutNamesProps,
-}) => ({
-    attributes: [ // default attributes
-        paginationProps.enable && {
-            type: 'number',
-            attribute: paginationProps.attribute,
-            defaultValue: paginationProps.defaultValue,
-        },
-        paginationSizeProps.enable && {
-            type: 'number',
-            attribute: paginationSizeProps.attribute,
-            defaultValue: paginationSizeProps.defaultValue,
-        },
-        sort.enable && {
-            type: 'string', // TODO Need list of strings
-            jsType: 'string[]',
-            attribute: sort.attribute,
-            defaultValue: sort.defaultValue,
-        },
-        layoutNamesProps.enable && {
-            type: 'string',
-            attribute: layoutNamesProps.attribute,
-            defaultValue: layoutNamesProps.defaultValue,
-        },
-    ].filter(Boolean),
-});
-
-export const createInitialValues = ({
-    paginationProps,
-    paginationSizeProps,
-    sort,
-    layoutNamesProps,
-    initialQuery,
-    configQuery,
-}) => ({
-    [paginationProps.attribute]: paginationProps.defaultValue,
-    [paginationSizeProps.attribute]: paginationSizeProps.defaultValue,
-    [sort.attribute]: sort.defaultValue,
-    [layoutNamesProps.attribute]: layoutNamesProps.defaultValue,
-    // TODO [this.props._layout.attribute]:
-    //  this.props.clientStorage.get(this.props._layout.attribute) || this.props._layout.defaultValue,
-    ...initialQuery, // Address bar
-    ...configQuery, // Query from props
-});
-
-/**
- * useList
- * Добавляет массу возможностей для взаимодействия с коллекциями. Коллекции можно получать как с бекенда,
- * так и передавать статичным массивом. В обоих случаях поддерживается пагинация, сортировка, фильтрация данных.
- * Выбранные фильтры синхронизируются с адресной строкой.
- */
-export default function useList(config: IListConfig): IListOutput {
-    // Get list from redux state
-    const list = useSelector(state => getList(state, config.listId));
-
-    // Normalize sort config
-    const sort = normalizeSortProps(config.sort);
-
-    // Empty
-    const Empty = require('../ui/list/Empty').default;
-    const emptyProps = normalizeEmptyProps(config.empty);
-    const renderEmpty = () => {
-        if (!emptyProps.enable || list?.isLoading || list?.items?.length > 0) {
-            return null;
-        }
-        return (
-            <Empty list={list} {...emptyProps} />
-        );
-    };
-
-    // Pagination size
-    const PaginationSize = require('../ui/list/PaginationSize').default;
-    const paginationSizeProps = normalizePaginationSizeProps(config.paginationSize);
-    const renderPaginationSize = () => paginationSizeProps.enable
-        ? (
-            <PaginationSize
-                list={list}
-                {...paginationSizeProps}
-            />
-        )
-        : null;
-
-    // Pagination
-    const Pagination = require('../ui/list/Pagination').default;
-    const paginationProps = normalizePaginationProps(config.pagination);
-    const renderPagination = () => paginationProps.enable
-        ? (
-            <Pagination
-                list={list}
-                {...paginationProps}
-                sizeAttribute={paginationSizeProps.attribute}
-            />
-        )
-        : null;
-
-    // Layout switcher
-    const LayoutNames = require('../ui/list/LayoutNames').default;
-    const layoutNamesProps = normalizeLayoutNamesProps(config.layout);
-    const renderLayoutNames = () => <LayoutNames list={list} {...layoutNamesProps} />;
-
-    // Models
-    const defaultSearchModel = useMemo(() => getDefaultSearchModel({
-        paginationProps,
-        paginationSizeProps,
-        sort,
-        layoutNamesProps,
-    }), [layoutNamesProps, paginationProps, paginationSizeProps, sort]);
-    const model = useModel(config.model);
-    const searchModel = useModel(config.searchModel || config.searchForm?.model, defaultSearchModel);
-
-    // Address bar synchronization
-    const {
-        initialQuery,
-        updateQuery,
-    } = useAddressBar({
-        enable: !!config.addressBar,
-        model: searchModel,
-        ...(typeof config.addressBar === 'boolean' ? {enable: config.addressBar} : config.addressBar),
-    });
-
-    // Outside search form
-    const searchFormFields = config.searchForm?.fields;
-    const SearchForm = require('../ui/list/SearchForm').default;
-    const initialValuesSearchForm = useMemo(() => (searchFormFields || []).reduce((acc, field) => {
-        const attribute = typeof field === 'string' ? field : field.attribute;
-        acc[attribute] = initialQuery?.[attribute];
-        return acc;
-    }, {}), [searchFormFields, initialQuery]);
-
-    const searchFormProps = {
-        listId: config.listId,
-        ...config.searchForm,
-        model: searchModel,
-        initialValues: initialValuesSearchForm,
-    };
-
-    const renderSearchForm = () => <SearchForm {...searchFormProps} />;
-
-    // Form id
-    const formId = _get(config, 'searchForm.formId') || config.listId;
-    const dispatch = useDispatch();
-
-    // List wrapper (form context)
-    const _initialValues = useMemo(() => createInitialValues({
-        paginationProps,
-        paginationSizeProps,
-        sort,
-        layoutNamesProps,
-        initialQuery,
-        configQuery: config.query,
-    }), [config.query, initialQuery, layoutNamesProps, paginationProps, paginationSizeProps, sort]);
-    const initialValues = useInitial(() => _initialValues);
-
-    const renderList = useCallback((children: any) => {
-        const Form = require('../ui/form/Form').default;
-        return (
-            <Form
-                formId={formId}
-                initialValues={initialValues}
-                view={false}
-                useRedux
-            >
-                {children}
-            </Form>
-        );
-    }, [formId, initialValues]);
-
-    // Init list in redux store
-    useMount(() => {
-        if (!list) {
-            const toDispatch: any = [
-                listInit(config.listId, {
-                    listId: config.listId,
-                    action: config.action || config.action === '' ? config.action : null,
-                    actionMethod: config.actionMethod || defaultConfig.actionMethod,
-                    onFetch: config.onFetch,
-                    condition: config.condition,
-                    scope: config.scope,
-                    items: null,
-                    sourceItems: config.items || null,
-                    total: config.initialTotal,
-                    isRemote: !config.items,
-                    primaryKey: config.primaryKey || defaultConfig.primaryKey,
-                    formId,
-                    loadMore: paginationProps.loadMore,
-                    pageAttribute: paginationProps.attribute || null,
-                    pageSizeAttribute: paginationSizeProps.attribute || null,
-                    sortAttribute: sort.attribute || null,
-                    layoutAttribute: layoutNamesProps.attribute || null,
-                }),
-            ];
-
-            if (config.initialItems || config.items) {
-                toDispatch.push(listSetItems(config.listId, config.initialItems || config.items));
-            }
-            if (!config.initialItems) {
-                toDispatch.push(listLazyFetch(config.listId));
-            }
-
-            dispatch(toDispatch);
-        }
-    });
-
-    // Check form values change
-    const formValues = useSelector(state => formSelector(state, formId, ({values}) => values));
-    const prevFormValues = usePrevious(formValues);
-
-    useUpdateEffect(() => {
-        if (prevFormValues && !_isEqual(formValues, prevFormValues)) {
-            // Has changes (but not page) -> reset page
-            const attribute = paginationProps.attribute;
-
-            if (prevFormValues?.[attribute] === formValues[attribute] && formValues[attribute] > 1) {
-                formValues[attribute] = paginationProps.defaultValue;
-                dispatch(formChange(formId, attribute, formValues[attribute]));
-            }
-
-            // Sync with address bar
-            updateQuery(formValues);
-
-            // Send request
-            if (config.autoFetchOnFormChanges !== false) {
-                dispatch(listLazyFetch(config.listId));
-            }
-        }
-    }, [config.autoFetchOnFormChanges, config.listId, dispatch, formId, formValues,
-        paginationProps.attribute, paginationProps.defaultValue, prevFormValues, updateQuery]);
-
-    // Check change query
-    const prevQuery = usePrevious(config.query);
-    useUpdateEffect(() => {
-        _union(Object.keys(prevQuery), Object.keys(config.query))
-            .forEach(key => {
-                if (_isEqual(prevQuery[key], config.query[key])) {
-                    dispatch(formChange(formId, key, config.query[key]));
-                }
-            });
-    }, [formId, prevQuery, config.query, dispatch]);
-
-    // Check change items
-    useUpdateEffect(() => {
-        dispatch([
-            listSetItems(config.listId, config.items),
-            listLazyFetch(config.listId),
-        ]);
-    }, [dispatch, config.items, config.listId]);
-
-    // Destroy
-    useUnmount(() => {
-        const autoDestroy = typeof config.autoDestroy === 'boolean' ? config.autoDestroy : defaultConfig.autoDestroy;
-        if (autoDestroy) {
-            dispatch(listDestroy(config.listId));
-        }
-    });
-
-    const onFetch = useCallback((params = {}) => {
-        dispatch(listFetch(config.listId, params));
-    }, [config.listId, dispatch]);
-
-    const onSort = useCallback((value) => {
-        dispatch(formChange(formId, sort.attribute, value));
-    }, [dispatch, formId, sort.attribute]);
-
-    return {
-        list,
-        model,
-        searchModel,
-        paginationPosition: paginationProps.position,
-        paginationSizePosition: paginationSizeProps.position,
-        layoutNamesPosition: layoutNamesProps.position,
-        renderList,
-        renderEmpty,
-        renderPagination,
-        renderPaginationSize,
-        renderLayoutNames,
-        renderSearchForm,
-        onFetch,
-        onSort,
-    };
-}

package/src/hooks/useModel.ts

@@ -1,14 +0,0 @@
-import {useMemo} from 'react';
-import {Model} from '../components/MetaComponent';
-import useComponents from './useComponents';
-
-export default function useModel(model: any, defaultModel: any = null): Model {
-    const components = useComponents();
-    return useMemo(
-        () => components.meta.normalizeModel(
-            typeof model === 'string' ? components.meta.getModel(model) : model,
-            defaultModel,
-        ),
-        [components.meta, defaultModel, model],
-    );
-}

package/src/hooks/useScreen.tsx

@@ -1,6 +0,0 @@
-import {useContext} from 'react';
-import {ScreenContext, IScreen} from '../providers/ScreenProvider';
-
-export default function useScreen(): IScreen {
-    return useContext(ScreenContext);
-}

package/src/hooks/useSelector.ts

@@ -1,7 +0,0 @@
-import {useSelector as useReduxSelector, shallowEqual, DefaultRootState} from 'react-redux';
-
-export default function useSelector<TState = any, TSelected = any>(
-    selector: (state: TState) => TSelected,
-): TSelected {
-    return useReduxSelector<TState, TSelected>(selector, shallowEqual);
-}

package/src/hooks/useSsr.ts

@@ -1,6 +0,0 @@
-import {useContext} from 'react';
-import {ISsr, SsrProviderContext} from '../providers/SsrProvider';
-
-export default function useSsr(): ISsr {
-    return useContext(SsrProviderContext) || {};
-}

package/src/hooks/useUniqueId.ts

@@ -1,10 +0,0 @@
-import {useRef} from 'react';
-import _uniqueId from 'lodash-es/uniqueId';
-
-export default function useUniqueId(prefix: string) {
-    const idRef = useRef();
-    if (!idRef.current) {
-        idRef.current = _uniqueId(prefix);
-    }
-    return idRef.current;
-}

package/src/index.d.ts

@@ -1,96 +0,0 @@
-declare module '*.json' {
-    const value: any;
-    export default value;
-}
-
-declare module '*.svg' {
-    const content: string;
-    export default content;
-}
-
-declare module '*.png' {
-    const content: string;
-    export default content;
-}
-
-/**
- * Метод для локализации фраз и предложений
- * @example {__('{count} {count, plural, one{день} few{дня} many{дней}}', {count: 2})}
- * @param {string} phrase
- * @param {object} params
- * @private
- */
-declare function __(phrase: string, params?: any): string;
-
-/**
- * Название цвета, соответствующее ему состоянию
- */
-declare type ColorName =
-    | 'primary'
-    | 'secondary'
-    | 'success'
-    | 'info'
-    | 'warning'
-    | 'danger'
-    | 'light'
-    | 'dark'
-    | string;
-
-/**
- * Уникальный ключ. ID, UUID или другое
- */
-declare type PrimaryKey = number | string;
-
-/**
- * Размер элемента
- */
-declare type Size = 'small' | 'middle' | 'large' | string;
-
-/**
- * Макет формы или ее части, влияющий на расположение полей
- */
-declare type FormLayoutName = 'default' | 'horizontal' | 'inline' | string;
-
-/**
- * Свойства для настройки макета формы
- */
-declare type FormLayout = FormLayoutName | boolean | {
-    layout?: FormLayoutName | boolean,
-    className?: string,
-    style?: any,
-    label?: boolean,
-    cols?: number[],
-    [key: string]: any,
-};
-
-/**
- * Объект из свойства `input` от redux-form
- */
-declare type FormInputType = {
-    name?: string,
-    value?: any,
-    onChange?: (...args: any[]) => any,
-};
-
-/**
- * Дополнительные CSS классы
- * @example my-block
- */
-declare type CssClassName = string;
-
-/**
- * Дополнительные стили
- * @example my-block
- */
-declare type CustomStyle = React.CSSProperties;
-
-/**
- * Переопределение view React компонента для кастомизации отображения
- * @example MyCustomView
- */
-declare type CustomView = React.ReactNode;
-
-/**
- * HTTP метод
- */
-declare type HttpMethod = 'get' | 'post' | 'put' | 'delete' | string;

package/src/providers/ComponentsProvider.tsx

@@ -1,37 +0,0 @@
-import * as React from 'react';
-import {PropsWithChildren} from 'react';
-
-declare global {
-    interface Window {
-        SteroidsComponents: IComponents,
-    }
-}
-
-export interface IComponents {
-    api?: any,
-    clientStorage?: any,
-    html?: any,
-    http?: any,
-    locale?: any,
-    store?: any,
-    ui?: any,
-    resource?: any,
-    ws?: any,
-    pushNotification?: any,
-    meta?: any,
-    [key: string]: any,
-}
-
-export interface IComponentsProviderProps extends PropsWithChildren<any> {
-    components: IComponents
-}
-
-export const ComponentsContext = React.createContext({} as IComponents);
-
-export default function ComponentsProvider(props: IComponentsProviderProps): JSX.Element {
-    return (
-        <ComponentsContext.Provider value={props.components}>
-            {props.children}
-        </ComponentsContext.Provider>
-    );
-}