@steroidsjs/core 3.0.0-beta.1 → 3.0.0-beta.100

package/ui/form/FieldSet/FieldSet.js

@@ -12,7 +12,11 @@ var __assign = (this && this.__assign) || function () {
 };
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -38,26 +42,24 @@ var isString_1 = __importDefault(require("lodash-es/isString"));
 var Field_1 = __importDefault(require("../Field"));
 var Form_1 = require("../Form/Form");
 var hooks_1 = require("../../../hooks");
-var form_1 = require("../../../utils/form");
 function FieldSet(props) {
-    var components = hooks_1.useComponents();
-    var context = react_1.useContext(Form_1.FormContext);
-    var contextValue = react_1.useMemo(function () { return ({
+    var components = (0, hooks_1.useComponents)();
+    var context = (0, react_1.useContext)(Form_1.FormContext);
+    var contextValue = (0, react_1.useMemo)(function () { return ({
         formId: props.formId || context.formId,
         model: props.model || context.model,
         prefix: [context.prefix, props.prefix]
             .filter(Boolean)
             .join('.'),
         size: props.size || context.size,
-        layout: form_1.mergeLayoutProp(context.layout, props.layout),
         provider: context.provider,
         reducer: context.reducer
-    }); }, [context.formId, context.layout, context.model, context.prefix, context.provider, context.reducer,
-        context.size, props.formId, props.layout, props.model, props.prefix, props.size]);
+    }); }, [context.formId, context.model, context.prefix, context.provider, context.reducer,
+        context.size, props.formId, props.model, props.prefix, props.size]);
     var FieldSetView = props.view || components.ui.getView('form.FieldSetView');
     return (react_1["default"].createElement(Form_1.FormContext.Provider, { value: contextValue },
         react_1["default"].createElement(FieldSetView, __assign({ className: props.className, label: props.label }, props),
             props.children,
-            (props.fields || []).map(function (field, index) { return (react_1["default"].createElement(Field_1["default"], __assign({ key: index }, (isString_1["default"](field) ? { attribute: field } : field), { prefix: contextValue.prefix }))); }))));
+            (props.fields || []).map(function (field, index) { return (react_1["default"].createElement(Field_1["default"], __assign({ key: index }, ((0, isString_1["default"])(field) ? { attribute: field } : field), { prefix: contextValue.prefix }))); }))));
 }
 exports["default"] = FieldSet;

package/ui/form/FileField/FileField.d.ts

@@ -1,27 +1,66 @@
-import * as React from 'react';
-import { IFileHocInput, IFileHocOutput } from '../../../hoc/file';
+import { IFileInput } from '../../../hooks/useFile';
 import { IFieldWrapperInputProps } from '../Field/fieldWrapper';
-export interface IFileFieldProps extends IFieldWrapperInputProps, IFileHocInput, IFileHocOutput {
+import { IButtonProps } from '../Button/Button';
+export declare enum FilesLayout {
+    list = "list",
+    wall = "wall"
+}
+interface IFileFieldCommonProps extends IFileInput {
     /**
      * Показать значок удаление файла
      * @example true
      */
     showRemove?: boolean;
-    buttonComponent?: React.ReactNode;
-    buttonProps?: any;
-    className?: CssClassName;
-    view?: CustomView;
-    itemView?: CustomView;
-    itemProps?: any;
+    /**
+     * Кастомная иконка для удаление файла
+     * @example true
+     */
+    customRemoveIcon?: string;
+    /**
+     * Вариант отображения файлов
+     * @example 'list'
+     */
+    filesLayout?: FilesLayout | string;
+}
+/**
+ * FileField
+ *
+ * Компонент `FileField` представляет собой поле формы для загрузки файлов.
+ * Он использует хук `useFile` для управления состоянием файлов и выполнения операций с файлами, таких как выбор и удаление.
+ * Компонент поддерживает различные варианты отображения файлов (список или стена) с помощью перечисления `FilesLayout`.
+ * На backendUrl по дефолту файл отправляется в теле запроса в виде бинарного кода.
+ * Чтобы отправлять файл в виде form-data (например в таком виде принимает файл FileModule в библиотеке steroidsjs/nest),
+ * нужно передать в `FileField` пропс uploaderConfig, в котором нужно указать поле useFormData: true.
+ **/
+export interface IFileFieldProps extends IFieldWrapperInputProps, IFileFieldCommonProps, IUiComponent {
+    /**
+     * View компонент для кнопки
+     * @example true
+     */
+    buttonView?: any;
+    /**
+     * Пропсы для кнопки
+     * @example true
+     */
+    buttonProps?: IButtonProps;
+    /**
+     * View компонент для элемента списка файлов
+     * @example true
+     */
+    itemView?: any;
+    /**
+     * Пропсы для элемента файла
+     * @example true
+     */
+    itemProps?: Record<string, any>;
     [key: string]: any;
 }
-export interface IFileFieldItemViewProps extends IFileHocInput, IFileHocOutput {
+export interface IFileFieldItemViewProps extends IFileFieldCommonProps {
     /**
      * Уникальный текстовый идентификатор
      * @example e65f5867-0083-48a7-af43-1121ed9e6280
      */
     uid?: string;
-    imagesOnly?: boolean;
     /**
      * ID файла
      * @example 34
@@ -33,13 +72,14 @@ export interface IFileFieldItemViewProps extends IFileHocInput, IFileHocOutput {
      */
     title?: string;
     disabled?: boolean;
-    showRemove?: boolean;
     /**
      * Обработчик события удаления файла
      * @param e
      */
     onRemove?: () => void;
     error?: string;
+    size?: number;
+    item?: Record<string, any>;
     image?: {
         /**
          * Url файла
@@ -57,34 +97,17 @@ export interface IFileFieldItemViewProps extends IFileHocInput, IFileHocOutput {
          */
         height: string;
     };
+    /**
+     * Обработчик события загрузки файлов
+     * @param e
+     */
+    onLoad?: () => void;
     progress?: {
         bytesUploaded: number;
         percent: number;
     };
 }
 export interface IFileFieldViewProps extends IFileFieldProps {
-    buttonComponent?: React.ReactNode | any;
-    imagesOnly?: boolean;
-    itemProps?: any;
-    buttonProps: {
-        /**
-         * Название поля
-         * @example Save
-         */
-        label?: string | any;
-        size?: boolean;
-        /**
-         * Переводит в неактивное состояние
-         * @example true
-         */
-        disabled?: boolean;
-        /**
-         * Обработчик события нажатия
-         * @param e
-         */
-        onClick?: (e: Event) => void;
-    };
-    itemView?: React.ReactNode | any;
     items: IFileFieldItemViewProps[];
 }
 declare const _default: import("../Field/fieldWrapper").FieldWrapperComponent<IFileFieldProps>;

package/ui/form/FileField/FileField.js

@@ -12,7 +12,11 @@ var __assign = (this && this.__assign) || function () {
 };
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -33,25 +37,38 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 exports.__esModule = true;
+exports.FilesLayout = void 0;
 var React = __importStar(require("react"));
 var File_1 = __importDefault(require("fileup-core/lib/models/File"));
 var first_1 = __importDefault(require("lodash-es/first"));
 var values_1 = __importDefault(require("lodash-es/values"));
+var react_1 = require("react");
 var useFile_1 = __importDefault(require("../../../hooks/useFile"));
 var hooks_1 = require("../../../hooks");
 var fieldWrapper_1 = __importDefault(require("../Field/fieldWrapper"));
-function FileField(props) {
-    var components = hooks_1.useComponents();
-    var _a = useFile_1["default"](props), files = _a.files, onBrowse = _a.onBrowse, onRemove = _a.onRemove;
+var FilesLayout;
+(function (FilesLayout) {
+    FilesLayout["list"] = "list";
+    FilesLayout["wall"] = "wall";
+})(FilesLayout = exports.FilesLayout || (exports.FilesLayout = {}));
+var FILE_STATUS_END = 'end';
+function FileFieldComponent(props) {
+    var components = (0, hooks_1.useComponents)();
+    var _a = (0, useFile_1["default"])(props), files = _a.files, onBrowse = _a.onBrowse, onRemove = _a.onRemove;
+    var _b = React.useState(false), isFilesLoaded = _b[0], setIsFilesLoaded = _b[1];
     var FileFieldView = props.view || components.ui.getView('form.FileFieldView');
     var FileFieldItemView = props.itemView || components.ui.getView('form.FileFieldItemView');
-    return (React.createElement(FileFieldView, __assign({}, props, { buttonComponent: props.buttonComponent, buttonProps: __assign({ label: props.imagesOnly
-                ? props.multiple
-                    ? __('Прикрепить фотографии')
-                    : __('Прикрепить фото')
-                : props.multiple
-                    ? __('Прикрепить файлы')
-                    : __('Прикрепить файл'), size: props.size, disabled: props.disabled, onClick: onBrowse }, props.buttonProps), itemView: FileFieldItemView, items: files.map(function (file) {
+    (0, react_1.useEffect)(function () {
+        setIsFilesLoaded(files.filter(function (file) { return file._status === FILE_STATUS_END; }).length === files.length);
+    }, [files]);
+    (0, react_1.useEffect)(function () {
+        if (isFilesLoaded && props.onLoad) {
+            props.onLoad();
+        }
+    }, [isFilesLoaded, props]);
+    return (React.createElement(FileFieldView, __assign({}, props, { buttonView: props.buttonView, buttonProps: __assign({ label: props.filesLayout === FilesLayout.wall
+                ? __('Upload')
+                : __('Click to Upload'), size: props.size, disabled: props.disabled, onClick: onBrowse }, props.buttonProps), itemView: FileFieldItemView, items: files.map(function (file) {
             var data = file.getResultHttpMessage() || {};
             var item = {
                 uid: file.getUid(),
@@ -80,10 +97,10 @@ function FileField(props) {
                 }
             }
             // Add thumbnail image
-            if (data.images) {
+            if (props.imagesOnly && data.images) {
                 // Image object has properties: url, width, height
                 item.image = data.images[props.imagesProcessor]
-                    || first_1["default"](values_1["default"](data.images));
+                    || (0, first_1["default"])((0, values_1["default"])(data.images));
             }
             // Add progress
             if (file.getStatus() === File_1["default"].STATUS_PROCESS) {
@@ -95,15 +112,22 @@ function FileField(props) {
             return item;
         }) })));
 }
+function FileField(props) {
+    if (process.env.IS_SSR) {
+        return null;
+    }
+    return (React.createElement(FileFieldComponent, __assign({}, props)));
+}
 FileField.defaultProps = {
     disabled: false,
     required: false,
+    filesLayout: FilesLayout.list,
     className: '',
     showRemove: true,
     buttonProps: {
-        color: 'secondary',
+        color: 'basic',
         outline: true
     },
     multiple: false
 };
-exports["default"] = fieldWrapper_1["default"]('FileField', FileField);
+exports["default"] = (0, fieldWrapper_1["default"])('FileField', FileField);

package/ui/form/Form/AutoSaveHelper.js

@@ -19,17 +19,17 @@ var AutoSaveHelper = /** @class */ (function () {
     function AutoSaveHelper() {
     }
     AutoSaveHelper.restore = function (clientStorage, formId, initialValues) {
-        var values = clientStorage.get(AutoSaveHelper.STORAGE_KEY_PREFIX + "_" + formId) || '';
-        if (isString_1["default"](values) && values.substr(0, 1) === '{') {
+        var values = clientStorage.get("".concat(AutoSaveHelper.STORAGE_KEY_PREFIX, "_").concat(formId)) || '';
+        if ((0, isString_1["default"])(values) && values.substr(0, 1) === '{') {
             return __assign(__assign({}, JSON.parse(values)), initialValues);
         }
         return initialValues;
     };
     AutoSaveHelper.save = function (clientStorage, formId, values) {
-        clientStorage.set(AutoSaveHelper.STORAGE_KEY_PREFIX + "_" + formId, JSON.stringify(values));
+        clientStorage.set("".concat(AutoSaveHelper.STORAGE_KEY_PREFIX, "_").concat(formId), JSON.stringify(values));
     };
     AutoSaveHelper.remove = function (clientStorage, formId) {
-        clientStorage.remove(AutoSaveHelper.STORAGE_KEY_PREFIX + "_" + formId);
+        clientStorage.remove("".concat(AutoSaveHelper.STORAGE_KEY_PREFIX, "_").concat(formId));
     };
     AutoSaveHelper.STORAGE_KEY_PREFIX = 'Form';
     return AutoSaveHelper;

package/ui/form/Form/Form.d.ts

@@ -1,17 +1,21 @@
 import * as React from 'react';
 import { IAddressBarConfig } from '../../../hooks/useAddressBar';
-import { IApiMethod } from '../../../components/ApiComponent';
 import { IFieldProps } from '../Field/Field';
 /**
  * Form
- * Компонент для создания формы
+ *
+ * Компонент для создания формы. Предоставляет управление и синхронизацию состояния формы,
+ * а также позволяет выполнять отправку данных формы на сервер с возможностью валидации и обработки результатов.
  */
-export interface IFormProps {
+export interface IFormProps extends IUiComponent {
     /**
      * Идентификатор формы
      * @example BookingForm
      */
     formId?: string;
+    /**
+    * Префикс
+    */
     prefix?: string;
     /**
      * Модель с полями формы
@@ -22,7 +26,7 @@ export interface IFormProps {
      * Url на который будет отправлена форма
      * @example api/v1/handle-form
      */
-    action?: string | IApiMethod;
+    action?: string;
     /**
      * Тип HTTP запроса (GET | POST | PUT | DELETE)
      * @example POST
@@ -33,11 +37,6 @@ export interface IFormProps {
      * @example Упс, что-то пошло не так
      */
     submitErrorMessage?: string;
-    /**
-     * Шаблон для полей в форме
-     * @example horizontal
-     */
-    layout?: FormLayout;
     /**
      * Обработчик события отправки формы
      * @param args
@@ -92,20 +91,7 @@ export interface IFormProps {
      */
     initialValues?: any | any[];
     /**
-     * Дополнительный CSS-класс для \<form\>...\<\/form\>
-     */
-    className?: CssClassName;
-    /**
-     * Объект CSS стилей
-     * @example {width: '45%'}
-     */
-    style?: any;
-    /**
-     * Переопределение view React компонента для кастомизации отображения
-     * @example MyCustomView
-     */
-    view?: CustomView;
-    /**
+     * Свойства для представления
      * @example {className: 'foo'}
      */
     viewProps?: any;
@@ -130,7 +116,7 @@ export interface IFormProps {
      */
     addressBar?: boolean | IAddressBarConfig;
     /**
-     * Если в форме есть элементы \<input\>, то произойдет автоматическая фокусировка на первом из них
+     * Если в форме есть элементы '<input>', то произойдет автоматическая фокусировка на первом из них
      * @example true
      */
     autoFocus?: boolean;
@@ -140,11 +126,6 @@ export interface IFormProps {
      * @example 'addComment'
      */
     captchaActionName?: string;
-    /**
-     * Включает рамки и тень.
-     * @example true
-     */
-    isBordered?: boolean;
     /**
      * Очищать ли данные формы с redux хранилища при размонтировании компонента. По-умолчанию - false
      * @example false
@@ -156,18 +137,9 @@ export interface IFormViewProps {
     submitLabel?: string;
     fields?: (string | IFieldProps)[];
     onSubmit: any;
-    isInvalid?: boolean;
     className?: CssClassName;
-    isBordered?: boolean;
     autoFocus?: boolean;
-    style?: any;
-    layout?: {
-        layout: FormLayoutName | boolean;
-        className: CssClassName;
-        label: boolean;
-        cols: number[];
-        [key: string]: any;
-    };
+    style?: CustomStyle;
     children?: React.ReactNode;
 }
 export interface IFormReducerState {
@@ -178,16 +150,37 @@ export interface IFormReducerState {
     isSubmitting: boolean;
 }
 export interface IFormContext {
+    /**
+    * Id формы
+    * @example {}
+    */
     formId?: string;
+    /**
+    * Модель с полями формы
+    */
     model?: any;
+    /**
+    * Префикс для полей формы
+    */
     prefix?: string | boolean;
-    layout?: FormLayout;
+    /**
+    * Размер компонента
+    */
     size?: Size;
+    /**
+    * Провайдер
+    */
     provider?: any;
+    /**
+    * Редьюсер
+    */
     reducer?: {
         dispatch: React.Dispatch<any>;
         select: any;
     };
+    /**
+    * Диспатч
+    */
     dispatch?: any;
 }
 export declare const FormContext: React.Context<IFormContext>;
@@ -196,7 +189,6 @@ declare namespace Form {
     var defaultProps: {
         actionMethod: string;
         autoStartTwoFactor: boolean;
-        layout: string;
         captchaActionName: string;
     };
 }