@apia/execution 4.0.26 → 4.0.27

package/dist/index.d.ts

@@ -3,7 +3,8 @@ import { IStringifyOptions } from 'qs';
 import { TableController, Row, Cell, CellState } from '@apia/table2-controller';
 import { DeepReadonly, EventEmitter as EventEmitter$1, TApiaLoad, TApiaFunction, TApiaLoadForm, Mutex } from '@apia/util';
 import { MobXTree } from '@apia/tree2-controller';
-import { ButtonProps } from 'theme-ui';
+import * as _apia_scheduler_controller from '@apia/scheduler-controller';
+import { TScheduleResult, Scheduler } from '@apia/scheduler-controller';
 
 type TApiaButtonDefinition = TApiaFieldBaseDefinition<TApiaButtonProperties> & {
     fieldType: 'button';
@@ -374,6 +375,12 @@ type TApiaTreeProperties = TApiaFieldCommonProperties & TApiaFieldWithAttributeP
     autoFocus?: string;
 };
 
+type TParseXmlBehavior = {
+    avoidTrimXml?: boolean;
+    avoidNormalize?: boolean;
+};
+declare const parseXml: <T = Record<string, unknown>>(xml: XMLDocument | string, behaveConfig?: TParseXmlBehavior) => T;
+
 interface TApiaMessage {
     label?: string;
     title: string;
@@ -399,9 +406,10 @@ interface IApiaApiRequestConfig {
     axiosConfig?: AxiosRequestConfig;
     stringifyOptions?: IStringifyOptions;
 }
-interface IApiaApiPostConfig<DataType> extends IApiaApiRequestConfig {
+interface IApiaApiPostConfig<DataType> extends IApiaApiRequestConfig, TParseXmlBehavior {
     postData?: DataType;
     postDataTreatment?: 'stringify';
+    allowAfterFinish?: boolean;
 }
 
 type TFormEventName = 'onLoad' | 'onSubmit' | 'onReload' | 'onBeforePrint' | 'onAfterPrint';
@@ -471,6 +479,7 @@ type TCustomComponentDefinition = {
     label: string;
     properties: ComponentProperties;
     event: ComponentEvent[];
+    error_while_processing?: string;
     state: {
         state: TCusCmpStateRequest;
     };
@@ -622,6 +631,7 @@ type TCustomComponentState = {
     attributes: Record<string, any[]>;
     properties: Record<string, any>;
     additional: any;
+    component: any;
 };
 declare class CustomComponent {
     #private;
@@ -662,6 +672,7 @@ declare class CustomComponent {
     } & {
         success: boolean;
     }) | undefined>;
+    setState<K extends keyof TCustomComponentState>(prop: K, value: TCustomComponentState[K]): void;
 }
 
 declare class Form extends WithProperties<TApiaFormProperties> {
@@ -721,10 +732,10 @@ declare class Form extends WithProperties<TApiaFormProperties> {
     private cucCmpByAttId;
     private cucCmpByFldId;
     private cucCmpByAttName;
+    private mustRenderFields;
     getCustomComponentByFldId(fldId: number): CustomComponent | undefined;
     getCustomComponentByAttId(attId: number): CustomComponent | undefined;
     getCustomComponentByAttName(attName: string): CustomComponent | undefined;
-    private mustRenderFields;
     addFieldToRender(fldId: string, fldIndex?: number): void;
     markFieldAsRendered(fldId: string, fldIndex?: number): void;
     init(): Promise<void>;
@@ -821,9 +832,11 @@ declare class Notifications {
     closeTab(): void;
     getAll(): Notification<NotificationDefinition>[];
     getById(id: string | number): Notification<NotificationDefinition> | undefined;
+    kill(): void;
     remove(notification: string | number | Notification): void;
-    on: <K extends "closeTab" | "notification">(event: K, cb: Callback<{
+    on: <K extends "closeTab" | "kill" | "notification">(event: K, cb: Callback<{
         closeTab: null;
+        kill: null;
         notification: Notification;
     }, K>) => UnSubscriber;
 }
@@ -1678,6 +1691,14 @@ declare abstract class FlowModal<T extends {
     abstract confirm(result: T): Promise<Status | FlowModal<any>>;
 }
 
+declare enum ExecutionState {
+    RUNNING = 0,
+    LOADING = 1,
+    FINISHED = 2,
+    RENDERING = 3,
+    CONFIRMING = 4,
+    FINISHED_WITH_ERROR = 5
+}
 type TOnClose = 'clearEvalPath' | 'confirmOkOnClose' | 'confirmOkOnCloseSplash' | 'confirmOkOnSaveSplash' | 'releaseOkOnClose' | null;
 type TErrMessage = {
     message: {
@@ -1829,13 +1850,6 @@ declare class ShowSign extends FlowModal<{
     }) => Promise<Status>);
 }
 
-declare enum ExecutionState {
-    RUNNING = 0,
-    LOADING = 1,
-    FINISHED = 2,
-    RENDERING = 3,
-    CONFIRMING = 4
-}
 type TExecutionConfig = {
     canConfirm: boolean;
     canGoBack: boolean;
@@ -1929,6 +1943,10 @@ declare class Execution extends EventEmitter$1<{
         stepNumber: number;
         status: "completed" | "pending" | "current";
     } | undefined;
+    /**
+     * Ends the current session
+     */
+    kill(): void;
     viewDocs(): Promise<(Record<string, unknown> & ResponseSysMessages) | undefined>;
     setStepTitle(stepNumber: number, stepTitle: string): void;
     validate(): Promise<true | Field>;
@@ -1950,7 +1968,7 @@ declare function isXmlResponse(response: AxiosResponse<unknown>): RegExpMatchArr
 declare function isHtmlResponse(response: AxiosResponse<unknown>): RegExpMatchArray | null;
 declare class InvalidSessionException extends Error {
 }
-declare const parseSuccessfulResponse: <LoadType extends Record<string, unknown>>(execution: Execution, response: AxiosResponse<string>) => Promise<(ResponseSysMessages & LoadType & {
+declare const parseSuccessfulResponse: <LoadType extends Record<string, unknown>, DataType = unknown>(execution: Execution, response: AxiosResponse<string>, behaveConfig?: IApiaApiPostConfig<DataType>) => Promise<(ResponseSysMessages & LoadType & {
     onClose?: string;
     code?: unknown;
     load?: LoadType | undefined;
@@ -2166,7 +2184,7 @@ interface IButton {
     action: Promise<() => unknown> | string;
     id: TActionButtons;
 }
-type TActionButtons = 'VIEW_DOCS' | 'CLOSE' | 'DELEGATE' | 'CLOSE' | 'CONFIRM' | 'NEXT' | 'PRINT' | 'PREVIOUS' | 'RELEASE' | 'SAVE' | 'SIGN' | 'SHARE';
+type TActionButtons = 'sbtEjeDoc' | 'btnClose' | 'lblExeDelegar' | 'btnCon' | 'btnSig' | 'btnStaPri' | 'btnAnt' | 'btnEjeLib' | 'btnGua' | 'SIGN' | 'lblShareMsg';
 type TApiaFieldType = 'area' | 'button' | 'captcha' | 'check' | 'editor' | 'file' | 'grid' | 'hidden' | 'href' | 'image' | 'input' | 'label' | 'multiple' | 'password' | 'radio' | 'select' | 'title' | 'tree' | 'form';
 type PossibleValue = {
     value: string | number;
@@ -2221,7 +2239,7 @@ declare class ApiaFunctions implements IApiaFunctions {
     getAllForms(): IApiaForm[];
     getAllFormsByType(type: 'P' | 'E'): IApiaForm[];
     getAttField(attType: 'P' | 'E', attId: string): IApiaField | IApiaField[] | undefined;
-    getButtonAction(id: number | string): TActionButtons;
+    getButtonAction(id: number | string): "sbtEjeDoc" | "btnClose" | "lblExeDelegar" | "btnCon" | "btnSig" | "btnStaPri" | "btnAnt" | "btnEjeLib" | "btnGua" | "lblShareMsg";
     getCurrentLanguageCode(): string | null;
     getCurrentProcessName(): string | null;
     getCurrentStep(): number | null;
@@ -2314,10 +2332,6 @@ declare class ButtonField extends ApiaField<TTextFieldProperties> implements IBu
     setValue(value: string): void;
 }
 
-type TEditorField = IApiaField;
-declare class EditorField extends ApiaField implements TEditorField {
-}
-
 declare class ApiaAttribute {
     #private;
     constructor(attribute: Attribute);
@@ -2338,6 +2352,10 @@ declare class ApiaFieldWithAttribute<T = string | boolean> extends ApiaField {
     getProperty<K extends keyof TApiaFieldWithAttributeProperties>(name: K): TApiaFieldWithAttributeProperties[K];
 }
 
+type TEditorField = IApiaField;
+declare class EditorField extends ApiaFieldWithAttribute implements TEditorField {
+}
+
 type TOptionsMap$2 = Map<string, PossibleValue>;
 type TOptionsAsArray = PossibleValue[];
 declare class SelectField extends ApiaFieldWithAttribute<string | number | (string | number)[]> {
@@ -2846,6 +2864,7 @@ type ModalInputValue = {
     storeValue?: string;
 };
 declare class ModalInput extends FieldWithAttribute<TApiaInputProperties, ModalInputValue> {
+    isLoading: boolean;
     constructor({ value, ...definition }: TApiaModalInputDefinition);
     fireEvent(eventName: InputEvents): Promise<boolean>;
     protected hasValue(): boolean;
@@ -2911,100 +2930,11 @@ declare class Tree extends FieldWithAttribute<TApiaTreeProperties, TTreeValue[],
     }> | undefined): Promise<boolean>;
 }
 
-type TSchedulerState = {
-    data?: TScheduleResult;
-    initialProps: IScheduleInitialProps;
-    url?: string;
-    selectedCell?: string | null;
-    focusStage?: string;
-    stageList?: string[];
-    selectedDay?: ISelectedDay;
-    stageData: IStage[];
-    isStageMounted: Record<string, boolean>;
-    validation: FieldValidationState;
-    isLoading?: 'NotLoading' | 'Today' | 'LastWeek' | 'DateInput' | 'NextWeek' | 'DeleteWeek';
-};
-type TSelectedDateResponse = {
-    success: boolean;
-};
-type TTskSchHour = {
-    hour: string;
-    disabled: boolean;
-    value: string;
-};
-type TTskSchDay = {
-    type: string;
-    day: string;
-    tskSchHour?: TTskSchHour | TTskSchHour[];
-    isDisabled?: boolean;
-};
-type TScheduleResult = {
-    calId: string;
-    mode: string;
-    overassign: string;
-    weekNotConfigured: boolean;
-    frec: string;
-    tskSchId: string;
-    mondayWeek: string;
-    success: boolean;
-    tskSchDay: TTskSchDay | TTskSchDay[];
-};
-interface IScheduleInitialProps {
-    schId: string;
-    proId: string;
-    proVerId: string;
-    tskId: string;
-    showDisponibility: string;
-    showAttributes: string;
-}
-interface ILabelSelectedDay {
-    hour: string;
-    day?: string | undefined;
-}
-interface ISelectedDay {
-    hour?: string;
-    day?: string;
-    mondayWeek?: string;
-    dayNumber?: number;
-    morningOrAfternoonSelected?: number | null;
-}
-interface IStage {
-    name: string;
-    buttons?: IStageButton[];
-}
-interface IStageButton extends ButtonProps {
-    label: string;
-    title: string;
-    action: () => unknown;
-    isDisabled?: boolean;
-    value?: string;
-    isSelectedSelector: () => boolean;
-}
-type TSchInfoResult = {
-    pro_instances: {
-        pro_instance: TProcesses;
-    };
-};
-type TProcesses = {
-    id: number;
-    attributes: {
-        attribute: {
-            title: string;
-            value: string;
-        }[];
-    };
-}[];
-
-declare function getCurrentDate(): string;
-interface ISchedulerStore {
-}
-declare class Scheduler extends Field<TApiaSchedulerProperties> {
-    state: TSchedulerState;
-    private inited;
-    protected readonly tableController: TableController;
+declare class SchedulerField extends Field<TApiaSchedulerProperties> {
+    private _schedController;
     constructor(definition: TApiaFieldBaseDefinition<TApiaSchedulerProperties>);
-    get controller(): TableController;
-    get initialProperties(): {
+    deleteDate(): Promise<boolean>;
+    get parsedInitialProperties(): {
         schId: string;
         proId: string;
         proVerId: string;
@@ -3013,24 +2943,10 @@ declare class Scheduler extends Field<TApiaSchedulerProperties> {
         showAttributes: string;
     };
     init(form: Form): Promise<void>;
-    loadWeek(weekDay?: string): Promise<void>;
-    private parseRows;
-    private isMorningTime;
-    setState(newState: Partial<TSchedulerState>): void;
-    setDay(day: ISelectedDay): void;
-    setStage({ index, newStage }: {
-        index: number;
-        newStage: IStage;
-    }): void;
-    syncStage(day: TTskSchDay, hour: number): void;
-    makeDaysStage(data?: TScheduleResult): void;
-    private makeMorningOrAfternoonStage;
-    private makeHoursStage;
-    deleteDate(): Promise<void>;
-    goNextWeek(): Promise<void>;
-    goPreviousWeek(): Promise<void>;
-    parsedDateLabel: () => string;
-    getSchedulerColumns(data: TScheduleResult | null): CellState[];
+    loadWeek(weekDay: string, schId: string, proId: string, proVerId: string, tskId: string): Promise<(TScheduleResult & ResponseSysMessages) | null>;
+    loadInfo(schId: string, weekDay: string, dayNumber: number, hour: string): Promise<_apia_scheduler_controller.TProcesses>;
+    markDay(weekDay: string, hour: string, dayNumber: number): Promise<void>;
+    get schedController(): Scheduler;
 }
 
 declare const IProperty: {
@@ -3335,9 +3251,7 @@ declare function getLabel(execution: Execution, label: string, replacers?: Parti
     tooltip: string;
 };
 
-declare const parseXml: <T = Record<string, unknown>>(xml: XMLDocument | string) => T;
-
 declare function parseFakeJSON<T extends Record<string, unknown>>(str: string): T;
 
-export { ActionsController, AdditionalCell, ApiaAttribute, ApiaField, ApiaFieldWithAttribute, ApiaForm, ApiaFunctions, BouncingEmitter, Button, ButtonField, Captcha, CaptchaField, CheckField, Checkbox, type ComponentEvent, CustomComponent, GridField as DataGridField, Editor, EditorField, EventEmitter, Execution, ExecutionState, Field, FieldWithAttribute, type FieldWithAttributeState, type FieldsMapping, File$1 as File, FileUploaderField, FlowModal, Form, FormsUploader, Grid, GridCell, GridField, GridPaginated, HeaderCell, Hidden, HiddenField, type IApiaField, type IApiaForm, type IApiaFunctions, type IButton, type IIProperty, type ILabelSelectedDay, type IPoolsPermissions, IProperty, type IScheduleInitialProps, type ISchedulerStore, type ISelectedDay, type ISignatureData, type IStage, type IStageButton, type IUsersPermissions, Image, ImageField, Input, InputField, InvalidSessionException, Label, Link, LinkField, MessageNotification, ModalInput, ModalInputField, Multiple, MultipleField, Notifications, Password, PasswordField, type PossibleValue, Radio, RadioField, type RadioPossibleValue, Scheduler, Select, SelectField, type SelectPossibleValue, ShowConfirmMessage, ShowPathSelection, ShowPoolSelection, ShowSign, ShowSignSelection, StatefulEmitter, type Status, StatusNotification, type TActionButtons, type TAjaxUploadFileStatus, type TAjaxUploadStart, type TApiaButtonProperties, type TApiaCaptchaProperties, type TApiaCheckboxProperties, type TApiaDocumentDefinition, type TApiaEditorProperties, type TApiaFieldBaseDefinition, type TApiaFieldCommonProperties, type TApiaFieldDefinition, type TApiaFieldPossibleValue, type TApiaFieldSizableFieldProperties, type TApiaFieldType, type TApiaFieldValueType, type TApiaFieldWithAttributeBaseProps, type TApiaFieldWithAttributeProperties, type TApiaFileProperties, type TApiaForm, type TApiaFormProperties, type TApiaGridProperties, type TApiaGroupableFieldProperties, type TApiaHiddenProperties, type TApiaImageProperties, type TApiaInputProperties, type TApiaLabelProperties, type TApiaLinkProperties, type TApiaMultipleProperties, type TApiaPasswordProperties, type TApiaRadioProperties, type TApiaSchedulerProperties, type TApiaSelectProperties, type TApiaTextareaProperties, type TApiaTitleProperties, type TApiaTranslatableFieldProperties, type TApiaTreePossibleValue, type TApiaTreeProperties, type TApiaValuatedFieldProperties, type TCheckWizardResponse, type TConfirmDropModal, type TCusCmpStateRequest, type TCustomComponentDefaultResponse, type TCustomComponentDefinition, type TDocInfo, type TDocType, type TDocumentDownloadHistory, type TDocumentInformation, type TDocumentMetadata, type TDocumentPermission, type TDocumentVersion, type TExecutionConfig, type TFetchConfirmPathResponse, type TFieldEvent, type TFieldScriptEvent, type TFieldScriptEventParameters, type TFieldScriptEvents, type TFieldServerEvent, type TFieldServerEvents, type TFileUploaded, type TFormEventName, type TFormScriptEvent, type TFormScriptEventParameters, type TFormScriptEvents, type TFrmParent, type TItemTreeObj, type TModalConfig, type TObservation, type TObservations, type TOnUploadProgress, type TPathType, type TProcessDroppedFiles, type TProcesses, type TRequireOnlyOne, type TSaveDroppedFilesConf, type TSchInfoResult, type TScheduleResult, type TSchedulerState, type TSelectedDateResponse, type TSignaturesData, type TTskSchDay, type TTskSchHour, type TUploadModalOpener, type TUploaderFileInfo, type TUploaderLoadCurrentFunction, type TUploaderLoadCurrentFunctionMessages, AreaField as TextAreaField, TextField, Textarea, Title, TranslatableField, Translation, Tree, TreeField, UploaderApi, UploaderModalController, type UploaderModalState, type UploaderState, createNewField, deepEqual, get, getCurrentDate, getLabel, isHtmlResponse, isJsonResponse, isOneClickUploadEnabled, isXmlResponse, makeApiaUrl, parseFakeJSON, parseFileDefinition, parseSuccessfulResponse, parseXml, post, returnExactlyTheSame, shallowEqual };
+export { ActionsController, AdditionalCell, ApiaAttribute, ApiaField, ApiaFieldWithAttribute, ApiaForm, ApiaFunctions, BouncingEmitter, Button, ButtonField, Captcha, CaptchaField, CheckField, Checkbox, type ComponentEvent, CustomComponent, GridField as DataGridField, Editor, EditorField, EventEmitter, Execution, ExecutionState, Field, FieldWithAttribute, type FieldWithAttributeState, type FieldsMapping, File$1 as File, FileUploaderField, FlowModal, Form, FormsUploader, Grid, GridCell, GridField, GridPaginated, HeaderCell, Hidden, HiddenField, type IApiaField, type IApiaForm, type IApiaFunctions, type IButton, type IIProperty, type IPoolsPermissions, IProperty, type ISignatureData, type IUsersPermissions, Image, ImageField, Input, InputField, InvalidSessionException, Label, Link, LinkField, MessageNotification, ModalInput, ModalInputField, Multiple, MultipleField, Notifications, Password, PasswordField, type PossibleValue, Radio, RadioField, type RadioPossibleValue, SchedulerField, Select, SelectField, type SelectPossibleValue, ShowConfirmMessage, ShowPathSelection, ShowPoolSelection, ShowSign, ShowSignSelection, StatefulEmitter, type Status, StatusNotification, type TActionButtons, type TAjaxUploadFileStatus, type TAjaxUploadStart, type TApiaButtonProperties, type TApiaCaptchaProperties, type TApiaCheckboxProperties, type TApiaDocumentDefinition, type TApiaEditorProperties, type TApiaFieldBaseDefinition, type TApiaFieldCommonProperties, type TApiaFieldDefinition, type TApiaFieldPossibleValue, type TApiaFieldSizableFieldProperties, type TApiaFieldType, type TApiaFieldValueType, type TApiaFieldWithAttributeBaseProps, type TApiaFieldWithAttributeProperties, type TApiaFileProperties, type TApiaForm, type TApiaFormProperties, type TApiaGridProperties, type TApiaGroupableFieldProperties, type TApiaHiddenProperties, type TApiaImageProperties, type TApiaInputProperties, type TApiaLabelProperties, type TApiaLinkProperties, type TApiaMultipleProperties, type TApiaPasswordProperties, type TApiaRadioProperties, type TApiaSchedulerProperties, type TApiaSelectProperties, type TApiaTextareaProperties, type TApiaTitleProperties, type TApiaTranslatableFieldProperties, type TApiaTreePossibleValue, type TApiaTreeProperties, type TApiaValuatedFieldProperties, type TCheckWizardResponse, type TConfirmDropModal, type TCusCmpStateRequest, type TCustomComponentDefaultResponse, type TCustomComponentDefinition, type TDocInfo, type TDocType, type TDocumentDownloadHistory, type TDocumentInformation, type TDocumentMetadata, type TDocumentPermission, type TDocumentVersion, type TExecutionConfig, type TFetchConfirmPathResponse, type TFieldEvent, type TFieldScriptEvent, type TFieldScriptEventParameters, type TFieldScriptEvents, type TFieldServerEvent, type TFieldServerEvents, type TFileUploaded, type TFormEventName, type TFormScriptEvent, type TFormScriptEventParameters, type TFormScriptEvents, type TFrmParent, type TItemTreeObj, type TModalConfig, type TObservation, type TObservations, type TOnUploadProgress, type TPathType, type TProcessDroppedFiles, type TRequireOnlyOne, type TSaveDroppedFilesConf, type TSignaturesData, type TUploadModalOpener, type TUploaderFileInfo, type TUploaderLoadCurrentFunction, type TUploaderLoadCurrentFunctionMessages, AreaField as TextAreaField, TextField, Textarea, Title, TranslatableField, Translation, Tree, TreeField, UploaderApi, UploaderModalController, type UploaderModalState, type UploaderState, createNewField, deepEqual, get, getLabel, isHtmlResponse, isJsonResponse, isOneClickUploadEnabled, isXmlResponse, makeApiaUrl, parseFakeJSON, parseFileDefinition, parseSuccessfulResponse, parseXml, post, returnExactlyTheSame, shallowEqual };
 //# sourceMappingURL=index.d.ts.map