eservices-core 1.0.516 → 1.0.518

package/dist/hooks/use-wizard.d.ts

@@ -0,0 +1,49 @@
+import { IWizardFixedResponse } from "./../index";
+/**
+ * @description Метод для работы с wizard и для контроллирования состояния.
+ * @param {String} entity Название сущности для которой вызывается wizard. Иными словами можно принимать данную строку
+ * как название области в которую для которой ищется процесс.
+ * @param {String} processName Название процесса, которые будет выполняться далее.
+ * @param options Объект опций, для изменения поведения визарда.
+ * */
+export declare function useWizard(entity: string, processName: string, options: IWizardOptions): {
+    initialize: () => Promise<void>;
+    state: {
+        wait: string | false;
+    };
+    currentStepConfig: any;
+    next: (changes?: any) => Promise<any>;
+};
+export interface IWizardState {
+    /**
+     * @description Параметр показыает на то, что на данный момент выполняется любой запрос на получение/изменение
+     * данных. В случае null, false - запрос не выполняется. Если тип занчения string, то запрос выполняется, а хранимое
+     * значение является label для спинера.
+     * */
+    wait: null | false | string;
+}
+export interface IWizardOptions {
+    onValidation: (arr: IWizardFixedResponse['validationResults']) => void;
+    onCompleted: (data: IWizardCompletedResult) => void;
+    onConfirmation: (data: IWizardConfirmationResult) => void;
+    presets?: Record<string, any>;
+}
+export declare type IWizardCompletedResult = IWizardFixedResponse & {
+    statusName: 'Completed';
+};
+export declare type IWizardConfirmationResult = IWizardFixedResponse & {
+    statusName: 'FinalStepWithConfirmation';
+};
+export declare type IWizardValidationErrorResult = IWizardFixedResponse & {
+    statusName: 'ValidationError';
+};
+export interface IWizardStepConfig {
+    label?: string;
+    name: string;
+    number: number;
+    fields: {
+        label: string;
+        name: string;
+        type: string;
+    }[];
+}

package/dist/index.d.ts

@@ -16,6 +16,7 @@ import { ListCell } from "./classes/List";
 import { IListCell } from "./classes/new/List";
 import { IAffectedEntity } from "./hooks/use-form-action";
 import { IWizardFixedResponse } from "./services/process-wizard-service";
+import { IWizardCompletedResult, IWizardConfirmationResult, IWizardValidationErrorResult, IWizardStepConfig } from "./hooks/use-wizard";
 import { setupSocket, useSocket } from "./socket/use-socket";
 import WidgetBreadcrumbs from "./widgets/breadcrumbs/widget-breadcrumbs.vue";
 import WidgetList from "./widgets/list/widget-list.vue";
@@ -69,6 +70,7 @@ import { useTableRequest, useTableState } from "./classes/table/Table";
 import { useCommunication } from "./classes/Communication";
 import useFormRequest from "./hooks/use-form-request";
 import { useProvideList, useListConfig, useListOrder, useListFilter } from "./classes/new/List";
+import { useWizard } from "./hooks/use-wizard";
 import { SYMBOL_ROW } from "./classes/table/Table";
 export { 
 /**
@@ -84,7 +86,7 @@ export { fileService, processWizardService, viewService, authService, dataServic
 /**
  * HOOKS
  * */
-export { useFormMetadata, useFormAction, useFormLabel, useFormRequestData, useListFilter, useListOrder, useListState, useCustomerState, useTableState, useTableRequest, useCommunication, useFormRequest, useManagerState, useProvideList, useListConfig, };
+export { useFormMetadata, useFormAction, useFormLabel, useFormRequestData, useListFilter, useListOrder, useListState, useCustomerState, useTableState, useTableRequest, useCommunication, useFormRequest, useManagerState, useProvideList, useListConfig, useWizard };
 /**
  * All components binding with VueComponents must have name started with Widget.
  * */
@@ -110,7 +112,7 @@ export { utils, Request };
 /**
  * Interfaces and Types
  * */
-export { IListCell, IListConfig, IFilterConfig, ISortConfig, ICustomerContext, IActionExecuteResult, IValidationEffect, INotificationCard, ApplicationType, IAffectedEntity, IWizardFixedResponse };
+export { IListCell, IListConfig, IFilterConfig, ISortConfig, ICustomerContext, IActionExecuteResult, IValidationEffect, INotificationCard, ApplicationType, IAffectedEntity, IWizardFixedResponse, IWizardCompletedResult, IWizardConfirmationResult, IWizardValidationErrorResult, IWizardStepConfig };
 declare const _default: {
     widgets: {
         inputs: {

package/dist/index.js

@@ -1,5 +1,5 @@
 /*!
-  * eservices-core v1.0.516
+  * eservices-core v1.0.518
   * (c) 2023 ESERVICES
   */
 'use strict';
@@ -5517,6 +5517,152 @@ function useFormRequest(form, formParams) {
     return { shadowFormState, initShadow };
 }
 
+function checkCompleted(res) {
+    return res.statusName === 'Completed';
+}
+function checkConfirmation(res) {
+    return res.statusName === "FinalStepWithConfirmation";
+}
+function checkValidationError(res) {
+    return res.statusName === 'ValidationError';
+}
+/**
+ * @description Метод для работы с wizard и для контроллирования состояния.
+ * @param {String} entity Название сущности для которой вызывается wizard. Иными словами можно принимать данную строку
+ * как название области в которую для которой ищется процесс.
+ * @param {String} processName Название процесса, которые будет выполняться далее.
+ * @param options Объект опций, для изменения поведения визарда.
+ * */
+function useWizard(entity, processName, options) {
+    /**
+     * @description Хранит значение токена, который передается при запросе.
+     * */
+    let token = null;
+    const state = vue.reactive({
+        wait: null
+    });
+    let stepsConfig = [];
+    let currentStep = null;
+    const currentStepConfig = vue.ref(null);
+    function updateFormFields() {
+        currentStepConfig.value = stepsConfig.find(v => v.name === currentStep) || null;
+    }
+    function getFields() {
+        var _a;
+        if (!currentStep)
+            return [];
+        return ((_a = stepsConfig.find(v => v.name === currentStep)) === null || _a === void 0 ? void 0 : _a.fields) || [];
+    }
+    function handleAnswer(res) {
+        updateFormFields();
+        if (checkValidationError(res)) {
+            return void options.onValidation(res.validationResults);
+        }
+        if ((res.statusName === 'FinalStep' || res.statusName === 'NextStep') && (!getFields().length || checkFieldsForValues(getFields(), options.presets))) {
+            return next(options.presets || {});
+        }
+        if (checkCompleted(res))
+            options.onCompleted(res);
+        if (checkConfirmation(res))
+            options.onConfirmation(res);
+    }
+    /**
+     * @description Функция инициализации процесса. Получает данные о процессе и запускает первый шаг.
+     * */
+    function initialize() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                yield updateWizardInformation();
+                yield requestStartProcess();
+            }
+            catch (e) {
+                const { message } = parseError(e);
+                NotificationSystem.add('error', message);
+            }
+        });
+    }
+    /**
+     * @description Получение информации о wizard-процессе.
+     * */
+    function updateWizardInformation() {
+        state.wait = "Loading process information.";
+        return processWizardService.getStartConfig(processName, entity)
+            .then(res => {
+            stepsConfig = res.steps.map(step => ({
+                label: step.title,
+                name: step.stepName,
+                number: step.number,
+                fields: step.frontendEntity.objectTypes.reduce((acc, frontendEntity) => {
+                    frontendEntity.properties.forEach(field => {
+                        acc.push({
+                            name: field.name,
+                            label: field.title,
+                            type: field.refEntityName || field.dataType
+                        });
+                    });
+                    return acc;
+                }, [])
+            }));
+        })
+            .then(res => {
+            state.wait = false;
+            return res;
+        });
+    }
+    function saveStepState(response) {
+        currentStep = response.nextStepName;
+        token = response.token;
+        return response;
+    }
+    function handleError(error) {
+        const parsedError = parseError(error);
+        NotificationSystem.add('error', parsedError.message);
+    }
+    /**
+     * @description Запрос(первый вызов) визарда в самом начале для инициализации процессе. В интерфейсе должен
+     * выполняться автоматически, после чтения метаданных.
+     * */
+    function requestStartProcess() {
+        state.wait = 'Starting process';
+        return processWizardService.startProcess(processName, entity)
+            .then(saveStepState)
+            .then(handleAnswer)
+            .catch(handleError)
+            .finally(() => {
+            state.wait = null;
+        });
+    }
+    function next(changes = {}) {
+        if (!token || !currentStep)
+            return Promise.reject('Not step or token.');
+        state.wait = 'Expect the result';
+        return processWizardService.runStep(processName, entity, currentStep, token, changes)
+            .then(saveStepState)
+            .then(handleAnswer)
+            .catch(handleError)
+            .finally(() => {
+            state.wait = false;
+        });
+    }
+    return {
+        initialize,
+        state,
+        currentStepConfig: vue.readonly(currentStepConfig),
+        next
+    };
+}
+/**
+ * @description Функция проверяет являются ли поля самозаполненными. В случае если все "да", то вёрнся true.
+ * */
+function checkFieldsForValues(fields, values) {
+    for (let i = 0; i < fields.length; i++) {
+        const item = fields[i];
+        if (!jenesiusVueForm.utils.getPropFromObject(values, item.name))
+            return false;
+    }
+    return true;
+}
+
 const utils = {
     clickOutside,
     requestHandler,
@@ -5597,5 +5743,6 @@ exports.useProvideList = useProvideList;
 exports.useSocket = useSocket;
 exports.useTableRequest = useTableRequest;
 exports.useTableState = useTableState;
+exports.useWizard = useWizard;
 exports.utils = utils;
 exports.viewService = viewService;

package/dist/services/process-wizard-service.d.ts

@@ -31,15 +31,32 @@ interface ObjectType {
 }
 interface IWizardProcessResponse {
     createdEntites: [];
-    dataSets: [];
+    dataSets: {
+        entityName: string;
+        note: null;
+        records: {
+            primaryKey: Record<string, any>;
+            values: any[];
+        }[];
+        title: string;
+        typeName: any;
+        viewFields: string[];
+    }[];
     nextStepName: string;
     notes: any[];
     statusCode: number;
     statusName: string;
     token: string;
-    validationResults: [];
+    validationResults: IValidationItem[];
 }
 export declare type IWizardFixedResponse = Omit<IWizardProcessResponse, 'createdEntites'> & {
     createdEntities: IWizardProcessResponse['createdEntites'];
 };
+export interface IValidationItem {
+    message: string;
+    name: string;
+    statusCode: number;
+    statusName: string;
+    title: string;
+}
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eservices-core",
-  "version": "1.0.516",
+  "version": "1.0.518",
   "description": "Core library",
   "author": "",
   "scripts": {