@apia/execution 4.0.42 → 4.0.44

package/dist/index.d.ts

@@ -1,10 +1,12 @@
+import * as _apia_scheduler_controller from '@apia/scheduler-controller';
+import { TScheduleResult, Scheduler } from '@apia/scheduler-controller';
+export { Scheduler } from '@apia/scheduler-controller';
 import { AxiosRequestConfig, AxiosResponse } from 'axios';
 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 * as _apia_util from '@apia/util';
+import { DeepReadonly, NotificationDefinition, EventEmitter as EventEmitter$1, T__LEGACY_SERVER__ApiaLoad, T__LEGACY_SERVER__ApiaFunction, TApiaLoadForm, Mutex } from '@apia/util';
 import { MobXTree } from '@apia/tree2-controller';
-import * as _apia_scheduler_controller from '@apia/scheduler-controller';
-import { TScheduleResult, Scheduler } from '@apia/scheduler-controller';
 
 type TApiaButtonDefinition = TApiaFieldBaseDefinition<TApiaButtonProperties> & {
     fieldType: 'button';
@@ -375,11 +377,13 @@ type TApiaTreeProperties = TApiaFieldCommonProperties & TApiaFieldWithAttributeP
     autoFocus?: string;
 };
 
-type TParseXmlBehavior = {
+type XMLParser<T = Record<string, unknown>> = (xml: XMLDocument | string, behaveConfig?: TParseXmlBehavior<T>) => T;
+type TParseXmlBehavior<T> = {
     avoidTrimXml?: boolean;
     avoidNormalize?: boolean;
+    xmlParser?: XMLParser<T>;
 };
-declare const parseXml: <T = Record<string, unknown>>(xml: XMLDocument | string, behaveConfig?: TParseXmlBehavior) => T;
+declare const parseXml: <T = Record<string, unknown>>(xml: XMLDocument | string, behaveConfig?: TParseXmlBehavior<T>) => T;
 
 interface TApiaMessage {
     label?: string;
@@ -407,11 +411,11 @@ interface IApiaApiRequestConfig {
     axiosConfig?: AxiosRequestConfig;
     stringifyOptions?: IStringifyOptions;
 }
-interface IApiaApiPostConfig<DataType> extends IApiaApiRequestConfig, TParseXmlBehavior {
-    postData?: DataType;
+type IApiaApiPostConfig<PostDataType, ResponseType = any> = IApiaApiRequestConfig & TParseXmlBehavior<ResponseType> & {
+    postData?: PostDataType;
     postDataTreatment?: 'stringify';
     allowAfterFinish?: boolean;
-}
+};
 
 type TFormEventName = 'onLoad' | 'onSubmit' | 'onReload' | 'onBeforePrint' | 'onAfterPrint';
 type TFrmParent = 'E' | 'P';
@@ -517,6 +521,7 @@ type SetValueOptions = Partial<{
     markAsDirty: boolean;
     synchronize: boolean;
     force: boolean;
+    fireEvents: boolean;
 }>;
 type FireEventParameters = Record<string, unknown>;
 type FieldValidationState = {
@@ -625,7 +630,6 @@ declare abstract class FieldWithAttribute<FieldProps extends TApiaFieldWithAttri
     protected processSynchronizeError(e: unknown): void;
     protected synchronize(newValue: ValueType): Promise<boolean>;
     protected hasValue(): boolean;
-    protected isValidValue(): boolean;
     validate(): Promise<boolean>;
     setError(err: string): void;
     protected getServerEventParams(evtId: number, additionalParams?: Record<string, any>): MakeApiaUrlProps;
@@ -871,6 +875,7 @@ declare class ApiaFunctions implements IApiaFunctions {
     setStepTitle(stepNumber: number, stepTitle: string): void;
     showActionButton(id: number): void;
     viewAdmEntity(entName: string, entNum?: number): void;
+    changeTab(index: number[]): void;
 }
 
 declare class ActionsController {
@@ -1042,7 +1047,7 @@ declare class ApiaForm implements IApiaForm {
     getAllFields(): IApiaField[];
     clearForm(clearReadonlyFields: boolean, deleteGridsRows: boolean): void;
     hideModal(): void;
-    showAsModal(): void;
+    showAsModal(size?: TModalSize): void;
 }
 
 declare abstract class ApiaField<Props extends typeof FieldConstants = typeof FieldConstants> implements IApiaField<Props> {
@@ -1086,6 +1091,7 @@ declare class ApiaFieldWithAttribute<T = string | boolean> extends ApiaField {
     clearValue(): void;
     getValue(): any;
     setValue(v: T): void;
+    protected _setValue(v: T, options: SetValueOptions): void;
     getLabel(): string | null | void;
     getProperty<K extends keyof TApiaFieldWithAttributeProperties>(name: TApiaFieldWithAttributeProperties[K]): unknown;
 }
@@ -1204,6 +1210,7 @@ declare class GridField extends ApiaField {
     deletePage(): void;
     deleteRow(index: number): Promise<void>;
     editRow(index: number): void;
+    getSelectedIndexes(useAbsoluteIndex?: boolean): number[];
     getAllColumns(): (IApiaField<Readonly<{
         TYPE_INPUT: "input";
         TYPE_SELECT: "select";
@@ -1814,6 +1821,7 @@ declare class FileUploaderField extends ApiaFieldWithAttribute {
     constructor(execution: Execution, field: File$1);
     onChange(cb: (newValue: unknown) => unknown): void;
     setValue(): null;
+    downloadDocument(): Promise<void>;
 }
 
 declare class PasswordField extends ApiaField {
@@ -1881,6 +1889,52 @@ declare class CustomComponent {
     setState<K extends keyof TCustomComponentState>(prop: K, value: TCustomComponentState[K]): void;
 }
 
+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: {
+        text: string;
+        label?: string;
+    };
+};
+type TFetchTaskActionResponse = {
+    onClose?: TOnClose;
+    sysMessages?: TErrMessage;
+    sysExceptions?: TErrMessage;
+    type?: string;
+    actions?: {
+        action: {
+            param: string[];
+            toDo: string;
+        };
+    };
+    load?: {
+        canClose: boolean;
+        type: string;
+        text: {
+            label: string;
+            closeAll: boolean;
+            addClass?: string;
+            title?: string;
+        };
+    };
+    text?: {
+        title?: string;
+        label?: string;
+    };
+};
+type FieldError = {
+    id: string;
+    errorMessage: string;
+};
+
 declare class Form extends WithProperties<TApiaFormProperties> {
     execution: Execution;
     fields: TApiaFieldBaseDefinition<Record<string, any>>[];
@@ -1945,6 +1999,7 @@ declare class Form extends WithProperties<TApiaFormProperties> {
     fireScriptEvent(eventName: TFormEventName): Promise<boolean>;
     validate(): Promise<true | Field>;
     getProperty<K extends keyof TApiaFormProperties>(propName: K | 'readOnly'): TApiaFormProperties[K];
+    getErrorsList(): FieldError[];
 }
 
 type TTranslationState = {
@@ -2002,17 +2057,6 @@ declare abstract class TranslatableField<FieldProps extends TApiaTranslatableFie
 type FieldConstructor = new (definition: any) => Field<any, any, any> | FieldWithAttribute<any, any, any> | TranslatableField<any, any, any>;
 type FieldsMapping = Record<string, (definition: any) => FieldConstructor>;
 
-type NotificationIcon = string;
-type NotificationType = 'info' | 'error' | 'success' | 'warning';
-type NotificationDefinition = {
-    icon?: NotificationIcon;
-    id?: string | number;
-    isOpen?: boolean;
-    message: string;
-    stackTrace?: string;
-    title?: string;
-    type?: NotificationType;
-};
 declare abstract class Notification<State extends NotificationDefinition = NotificationDefinition> {
     readonly props: State;
     protected state: State;
@@ -2023,7 +2067,7 @@ declare abstract class Notification<State extends NotificationDefinition = Notif
     get message(): string;
     get stackTrace(): string | undefined;
     get title(): string | undefined;
-    get type(): NotificationType | undefined;
+    get type(): _apia_util.NotificationType | undefined;
 }
 
 declare class Notifications {
@@ -2033,8 +2077,8 @@ declare class Notifications {
     protected notifications: Notification[];
     add(notification: Notification): void;
     closeTab(): void;
-    getAll(): Notification<NotificationDefinition>[];
-    getById(id: string | number): Notification<NotificationDefinition> | undefined;
+    getAll(): Notification<_apia_util.NotificationDefinition>[];
+    getById(id: string | number): Notification<_apia_util.NotificationDefinition> | undefined;
     kill(): void;
     remove(notification: string | number | Notification): void;
     on: <K extends "closeTab" | "kill" | "notification">(event: K, cb: Callback<{
@@ -2264,6 +2308,7 @@ declare class UploaderApi extends EventEmitter$1<{
     lockDocument(id: string): Promise<void>;
     protected evaluateDeleteDocumentResult(result: unknown): boolean;
     setTranslationFile(file: TUploaderFileInfo, docId: string, langId: number): void;
+    protected getCheckSignatureParameters: typeof returnExactlyTheSame;
     protected getAjaxUploadFileStatusParameters: typeof returnExactlyTheSame;
     protected getAjaxUploadStartParameters: typeof returnExactlyTheSame;
     protected getConfirmDropModalParameters: typeof returnExactlyTheSame;
@@ -2434,7 +2479,7 @@ type TFileUploaded = {
     virtualDoc?: boolean;
     locked?: boolean;
 };
-type TAjaxUploadStart = TApiaLoad<TApiaFunction<{
+type TAjaxUploadStart = T__LEGACY_SERVER__ApiaLoad<T__LEGACY_SERVER__ApiaFunction<{
     general: {
         isDocTypeDisabled: boolean;
         useDocTypePermitted: boolean;
@@ -2496,13 +2541,13 @@ type TSaveDroppedFilesConf = {
     translatingFile?: TUploaderFileInfo;
     shouldReset?: boolean;
 };
-type TAjaxUploadFileStatus = TApiaLoad<TApiaFunction<{
+type TAjaxUploadFileStatus = T__LEGACY_SERVER__ApiaLoad<T__LEGACY_SERVER__ApiaFunction<{
     message: {
         label: string;
         name: string;
     }[];
 }>>;
-type TProcessDroppedFiles = TApiaLoad<TApiaFunction<{
+type TProcessDroppedFiles = T__LEGACY_SERVER__ApiaLoad<T__LEGACY_SERVER__ApiaFunction<{
     principal: {
         docInfo: TDocInfo | TDocInfo[];
         docTypes: {
@@ -2524,7 +2569,7 @@ type TDocInfo = {
     docInfoTmpId: string;
     docInfoType: string;
 };
-type TConfirmDropModal = TApiaLoad<TApiaFunction<{
+type TConfirmDropModal = T__LEGACY_SERVER__ApiaLoad<T__LEGACY_SERVER__ApiaFunction<{
     general: TFileUploaded | TFileUploaded[];
     fromForm: {
         fromForm: {
@@ -2562,7 +2607,7 @@ type TUploaderLoadCurrentFunction = {
         }[];
     };
 };
-type TDocumentInformation = TApiaLoad<TApiaFunction<{
+type TDocumentInformation = T__LEGACY_SERVER__ApiaLoad<T__LEGACY_SERVER__ApiaFunction<{
     data: {
         onClose: string;
         general: TApiaDocumentDefinition;
@@ -2885,13 +2930,9 @@ declare class Observations {
     constructor(execution: Execution);
     private hasInited;
     init(): Promise<void>;
-    getConfirmParams(): {
-        txtComment: string | undefined;
-        chkAddAlert: string | undefined;
-        chkAddAllAlert: string | undefined;
-        chkRemAlert: string | undefined;
-    };
+    getConfirmParams(): Record<string, unknown>;
     setPriority(newPriority: string): void;
+    areObservationsChecked(): boolean;
 }
 
 type ConfirmStep = 'CHECK_LOCK' | 'CONFIRM' | 'CHECK_SIGN' | 'CHECK_WIZARD' | 'SIGN';
@@ -2906,48 +2947,6 @@ 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: {
-        text: string;
-        label?: string;
-    };
-};
-type TFetchTaskActionResponse = {
-    onClose?: TOnClose;
-    sysMessages?: TErrMessage;
-    sysExceptions?: TErrMessage;
-    type?: string;
-    actions?: {
-        action: {
-            param: string[];
-            toDo: string;
-        };
-    };
-    load?: {
-        canClose: boolean;
-        type: string;
-        text: {
-            label: string;
-            closeAll: boolean;
-            addClass?: string;
-            title?: string;
-        };
-    };
-    text?: {
-        title?: string;
-        label?: string;
-    };
-};
-
 type TCheckWizardResponse = {
     url: string;
 };
@@ -3076,6 +3075,7 @@ type TExecutionConfig = {
     canShare: boolean;
     isEntity?: boolean;
 };
+type TModalSize = 'editGrid' | 'sm' | 'md' | 'md-fixed' | 'lg' | 'lg-fixed' | 'xl' | 'xl-fixed' | 'xxl' | 'xxxl' | 'xxxl-fixed' | 'flex' | 'cal' | 'finder' | 'fileModal';
 type TExecutionEnvironment = {
     fieldsMapping?: FieldsMapping;
     window: Window;
@@ -3090,7 +3090,10 @@ declare class Execution extends EventEmitter$1<{
     flow: 'previous' | 'confirm' | 'next' | 'save' | 'release' | 'share' | 'viewDocs' | 'print' | 'delegate';
     sendToDesktop: null;
     hideFormModal: Form;
-    showFormAsModal: Form;
+    showFormAsModal: {
+        form: Form;
+        size?: TModalSize;
+    };
 }> {
     environment: TExecutionEnvironment;
     fieldsMapping: FieldsMapping;
@@ -3104,6 +3107,7 @@ declare class Execution extends EventEmitter$1<{
     private _stepCount;
     readonly notifications: Notifications;
     private lastModalReturn;
+    private _pendingPromises;
     constructor(environment: TExecutionEnvironment);
     protected formsById: {
         E: Map<string, Form>;
@@ -3118,6 +3122,8 @@ declare class Execution extends EventEmitter$1<{
         locked: number;
         hasChangedAnything: boolean;
     };
+    addPendingPromise(promise: Promise<boolean>): void;
+    getErrorsList(): FieldError[];
     getAllForms(): Form[];
     private hasInitializedFormsTabs;
     initializeFormsTabs(frmParent: TFrmParent, cb: () => unknown): void;
@@ -3181,6 +3187,7 @@ declare class Execution extends EventEmitter$1<{
     setLastModalReturn(value: string[]): void;
     getLastModalReturn(): string[];
     private fireEvents;
+    waitForPendingSyncs(): Promise<void>;
 }
 
 declare global {
@@ -3196,10 +3203,10 @@ 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>, DataType = unknown>(execution: Execution, response: AxiosResponse<string>, behaveConfig?: IApiaApiPostConfig<DataType>) => Promise<(ResponseSysMessages & LoadType & {
+declare const parseSuccessfulResponse: <ResponseType extends Record<string, unknown>, PostDataType = unknown>(execution: Execution, response: AxiosResponse<string>, behaveConfig?: IApiaApiPostConfig<PostDataType, ResponseType>) => Promise<(ResponseSysMessages & ResponseType & {
     onClose?: string;
     code?: unknown;
-    load?: LoadType | undefined;
+    load?: ResponseType | undefined;
 }) | ({
     actions: unknown;
     onClose: string | undefined;
@@ -3212,7 +3219,7 @@ declare const parseSuccessfulResponse: <LoadType extends Record<string, unknown>
     sysMessages: {
         message: TApiaMessage | TApiaMessage[];
     } | undefined;
-} & LoadType) | null>;
+} & ResponseType) | null>;
 /**
 * IMPORTANT!! The ApiaApi is programmed under the slogan that
  * **should never throw an exception**. **Errors** coming from
@@ -3261,7 +3268,7 @@ declare const parseSuccessfulResponse: <LoadType extends Record<string, unknown>
   }
  * @returns The type of the return value depends on the type passed when calling the function. If there was an error it returns null.
  */
-declare function post<LoadType extends Record<string, unknown> = Record<string, unknown>, DataType = unknown, T = unknown>(execution: Execution, actualUrl: string, behaveConfig?: IApiaApiPostConfig<DataType>): TApiaApiResult<LoadType>;
+declare function post<LoadType extends Record<string, unknown> = Record<string, unknown>, DataType = unknown, T = unknown>(execution: Execution, actualUrl: string, behaveConfig?: IApiaApiPostConfig<DataType, LoadType>): TApiaApiResult<LoadType>;
 /**
  * IMPORTANTE!! El ApiaApi está programado bajo la consigna de que
  * **no debe tirar núnca una excepción**. **Los errores** provenientes
@@ -3403,7 +3410,7 @@ declare class Checkbox extends FieldWithAttribute<TApiaCheckboxProperties, boole
 type EditorEvents = 'onChange';
 declare class Editor extends TranslatableField<TApiaEditorProperties, string> {
     fireEvent(eventName: EditorEvents, options?: TFireEventOptions): Promise<boolean>;
-    protected isValidValue(): boolean;
+    protected hasValue(): boolean;
     protected getSynchronizePostConfiguration(value: string): IApiaApiPostConfig<any>;
 }
 
@@ -3416,6 +3423,7 @@ declare class File$1 extends FieldWithAttribute<TApiaFileProperties> {
         synchronize: boolean;
     }> | undefined): Promise<boolean>;
     loadFromDefinition(def: string): void;
+    downloadDocument(): Promise<void>;
 }
 
 type GridEvents = 'gridAdd' | 'gridDelete' | 'gridSort' | 'gridColumnSelect';
@@ -3601,7 +3609,7 @@ declare class Grid extends Field<GridProps, GridDefinition, GridState> {
         definition: Omit<TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, "properties">;
     }>[];
     protected rebuildGrid(xmlString: string | TApiaGridDefinition): Promise<void>;
-    protected runAction<T extends Record<string, any>>(behave: IApiaApiPostConfig<Record<string, any>>): Promise<TApiaApiAxiosResponse<(T & ResponseSysMessages) | null> | null>;
+    protected runAction<T extends Record<string, any>>(postData: IApiaApiPostConfig<Record<string, any>>): Promise<TApiaApiAxiosResponse<(T & ResponseSysMessages) | null> | null>;
     private swapRows;
     toggleMaximize(): void;
 }
@@ -3612,6 +3620,11 @@ declare class GridPaginated extends Grid {
      */
     get finalIndex(): number;
     addRow(): Promise<boolean>;
+    protected actualDeleteRows(props: {
+        index?: number | number[];
+        action?: string;
+    }): Promise<boolean>;
+    deleteAllRows(): Promise<boolean>;
     deleteRows(index?: number | number[]): Promise<boolean>;
     gotoPage(page: number): Promise<boolean>;
     sortDown(index?: number | number[]): Promise<boolean>;
@@ -3652,7 +3665,7 @@ declare class Input extends TranslatableField<TApiaInputProperties, string, TApi
     setValue(newValue: string | Date | number, options?: SetValueOptions): Promise<boolean>;
     private validateRegex;
     validate(): Promise<boolean>;
-    protected isValidValue(): boolean;
+    protected hasValue(): boolean;
 }
 
 declare class Label extends Field<TApiaLabelProperties, TApiaLabelDefinition> {
@@ -3710,7 +3723,7 @@ declare class Multiple extends FieldWithAttribute<TApiaMultipleProperties, strin
 }
 
 declare class Password extends FieldWithAttribute<TApiaPasswordProperties, string> {
-    protected isValidValue(): boolean;
+    protected hasValue(): boolean;
 }
 
 type RadioEvents = 'onPopulate' | 'onChange' | 'onClick';
@@ -3729,7 +3742,7 @@ declare class Select extends FieldWithAttribute<TApiaSelectProperties, string, T
 }
 
 declare class Textarea extends TranslatableField<TApiaTextareaProperties, string> {
-    protected isValidValue(): boolean;
+    protected hasValue(): boolean;
     protected getSynchronizePostConfiguration(value: string): IApiaApiPostConfig<any>;
 }
 
@@ -3747,7 +3760,6 @@ declare class Tree extends FieldWithAttribute<TApiaTreeProperties, TTreeValue[],
     protected hasValue(): boolean;
     setProperty<K extends keyof TApiaTreeProperties>(propName: K, propValue: TApiaTreeProperties[K]): void;
     init(form: Form): Promise<void>;
-    protected isValidValue(): boolean;
     setValue(newValue: TTreeValue[], options?: Partial<{
         comparator: Comparator$1<any>;
         format: 'd/m/Y' | 'apia';