@apia/execution 4.0.24 → 4.0.26

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 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, Mutex, TApiaLoadForm } from '@apia/util';
+import { DeepReadonly, EventEmitter as EventEmitter$1, TApiaLoad, TApiaFunction, TApiaLoadForm, Mutex } from '@apia/util';
 import { MobXTree } from '@apia/tree2-controller';
 import { ButtonProps } from 'theme-ui';
 
@@ -320,6 +320,7 @@ type TApiaSchedulerProperties = TApiaFieldCommonProperties & TApiaValuatedFieldP
 };
 type TApiaLabelProperties = TApiaFieldCommonProperties & TApiaValuatedFieldProperties & TApiaGroupableFieldProperties & {
     underlined?: boolean;
+    value?: string;
 };
 type TApiaLinkProperties = TApiaFieldCommonProperties & TApiaValuatedFieldProperties & TApiaGroupableFieldProperties & {
     url?: string;
@@ -359,7 +360,9 @@ type TApiaTextareaProperties = TApiaFieldCommonProperties & TApiaTranslatableFie
     placeHolder?: string;
     title?: string;
 };
-type TApiaTitleProperties = TApiaFieldCommonProperties & TApiaValuatedFieldProperties & {};
+type TApiaTitleProperties = TApiaFieldCommonProperties & TApiaValuatedFieldProperties & {
+    value?: string;
+};
 type TApiaTreeProperties = TApiaFieldCommonProperties & TApiaFieldWithAttributeProperties & TApiaFieldSizableFieldProperties & {
     height?: string;
     leafIcon?: string;
@@ -579,6 +582,7 @@ declare class WithProperties<Props extends Record<string, any>> {
     properties: Props;
     private parentGrid;
     constructor(initialState?: Props);
+    getParentGrid(): Grid | null;
     getProperty<K extends keyof Props>(propName: K): Props[K];
     setProperty<K extends keyof Props>(propName: K, propValue: SetStateAction<Props[K]>): void;
     setParentGrid(grid: Grid): this;
@@ -648,6 +652,7 @@ declare class CustomComponent {
     sendMessage<T extends Record<string, unknown> = Record<string, unknown>>(payload: any): Promise<(T & {
         success: boolean;
     }) | undefined>;
+    download(attName: string, index: number): Promise<void>;
     upload(attName: string, file: File, options?: {
         onUploadProgress?: (percent: number) => unknown;
         params?: Record<string, any>;
@@ -744,6 +749,7 @@ declare class Translation {
     cancelTranslation(): void;
     readTranslations(url: string): Promise<void>;
     reset(): void;
+    deleteTranslation(): void;
     setTempValue(str: string): void;
     submitTranslation(value: string, url: string): void;
     get langId(): string;
@@ -763,6 +769,7 @@ declare abstract class TranslatableField<FieldProps extends TApiaTranslatableFie
     private getLanguages;
     init(form: Form): Promise<void>;
     cancelTranslations(): void;
+    deleteTranslations(): void;
     changeLanguage(langId: string): Promise<void>;
     getTranslation(id: string): Translation | undefined;
     getCurrentTranslation(): Translation | undefined;
@@ -770,6 +777,12 @@ declare abstract class TranslatableField<FieldProps extends TApiaTranslatableFie
     submitTranslations(): void;
     syncTranslation(): Promise<void>;
     validate(): Promise<boolean>;
+    setValue(newValue: ValueType, options?: Partial<{
+        comparator: Comparator$1<any>;
+        format: 'd/m/Y' | 'apia';
+        markAsDirty: boolean;
+        synchronize: boolean;
+    }> | undefined): Promise<boolean>;
 }
 
 type FieldConstructor = new (definition: any) => Field<any, any, any> | FieldWithAttribute<any, any, any> | TranslatableField<any, any, any>;
@@ -1005,7 +1018,7 @@ declare class UploaderApi extends EventEmitter$1<{
         docId: string;
         docTypeId: number | string;
     }>, additionalProps?: Record<string, unknown>): Promise<void>;
-    saveDroppedFiles(unprocessedFiles: File[], conf?: TSaveDroppedFilesConf): Promise<void>;
+    saveDroppedFiles(unprocessedFiles: File[], conf?: TSaveDroppedFilesConf): Promise<boolean>;
     checkWebDavLock(docId: string): Promise<unknown>;
     checkSignature(file: TUploaderFileInfo): Promise<TApiaApiAxiosResponse<({
         markedToSign: boolean;
@@ -1020,7 +1033,7 @@ declare class UploaderApi extends EventEmitter$1<{
     }): Promise<void>;
     versionFileInfo(file: TUploaderFileInfo): Promise<void>;
     pickFileById(id: string): Promise<void>;
-    markFileToSign(id: string, langId?: number): Promise<void>;
+    markFileToSign(id: string, langId?: string): Promise<void>;
     /**
      * Por el momento realiza la descarga de todos los archivos
      * que estén subidos.
@@ -1105,6 +1118,7 @@ declare class UploaderModalController {
     addFiles(files: File[]): void;
     addDirectoryFile(file: TApiaDocumentDefinition): void;
     changeDocType(docTypeId: string): Promise<void>;
+    clearDirectoryFile(): void;
     clearFile(name: string): void;
     clearFiles(): void;
     clearState(): void;
@@ -1131,6 +1145,7 @@ type UploaderModalState = {
     docFolder?: number;
     docExpDate?: string;
     description: string;
+    isReadonly?: boolean;
     permissions: {
         allowAllType: 'M' | 'R' | '';
         users: IUsersPermissions[];
@@ -1476,7 +1491,7 @@ declare class FormsUploader extends UploaderApi {
     downloadDocument(fileId: string): Promise<void>;
     loadCurrentDocuments(): Promise<void>;
     parseFileDefinition: (file: TFileUploaded) => TUploaderFileInfo;
-    saveDroppedFiles(unprocessedFiles: File[], conf?: TSaveDroppedFilesConf | undefined): Promise<void>;
+    saveDroppedFiles(unprocessedFiles: File[], conf?: TSaveDroppedFilesConf | undefined): Promise<boolean>;
 }
 
 declare class Process {
@@ -1697,6 +1712,123 @@ type TFetchTaskActionResponse = {
     };
 };
 
+type TCheckWizardResponse = {
+    url: string;
+};
+type TFetchConfirmPathResponse = {
+    onClose?: string;
+    sysMessages?: {
+        message?: {
+            text: string;
+        };
+    };
+    pathSelection?: boolean | null;
+    groupSelection?: boolean | null;
+    load?: TApiaLoadForm & {
+        type: 'form' | 'text' | 'table' | 'function';
+        canClose: boolean;
+        text?: {
+            closeAll: string;
+            title: string;
+            addClass: string;
+            label: string;
+            content?: string;
+        };
+    };
+    actions?: {
+        action: {
+            toDo: 'functionTimedCall';
+            param: [number, string];
+        };
+    };
+};
+type TItemTreeObj = {
+    id: string;
+    name: string;
+    level: number;
+    value: boolean;
+    type: TPathType;
+    isOn: boolean;
+};
+type TPathType = 'OR' | 'XOR' | 'AND';
+
+declare class ShowPathSelection extends FlowModal<{
+    confirmed: boolean;
+    path: string;
+}> {
+    fetchResult: TApiaLoadForm['form'];
+    confirm: (result: {
+        confirmed: boolean;
+        path: string;
+    }) => Promise<Status | FlowModal<any>>;
+    state: {
+        disabledParents: TItemTreeObj | TItemTreeObj[] | null;
+        groupSelectionObj: TFetchConfirmPathResponse | null;
+    };
+    constructor(fetchResult: TApiaLoadForm['form'], confirm: (result: {
+        confirmed: boolean;
+        path: string;
+    }) => Promise<Status | FlowModal<any>>);
+    setDisabledParent(treeItem: TItemTreeObj): void;
+    clearPaths(): void;
+    showGroupsSelection(fetchConfirmPathResponse: TFetchConfirmPathResponse): void;
+    updateDisabledList(itemObj: TItemTreeObj, itemArr: TItemTreeObj[]): TItemTreeObj[];
+}
+
+declare class ShowPoolSelection extends FlowModal<{
+    confirmed: boolean;
+    group: string;
+}> {
+    fetchResult: TApiaLoadForm['form'];
+    confirm: (result: {
+        confirmed: boolean;
+        group: string;
+    }) => Promise<Status>;
+    constructor(fetchResult: TApiaLoadForm['form'], confirm: (result: {
+        confirmed: boolean;
+        group: string;
+    }) => Promise<Status>);
+}
+
+declare class ShowSignSelection extends FlowModal<{
+    confirmed: boolean;
+    signed: boolean;
+}> {
+    fetchResult: any;
+    confirm: (result: {
+        confirmed: boolean;
+        signed: boolean;
+    }) => Promise<Status>;
+    constructor(fetchResult: any, confirm: (result: {
+        confirmed: boolean;
+        signed: boolean;
+    }) => Promise<Status>);
+}
+
+declare class ShowConfirmMessage extends FlowModal<{
+    confirmed: boolean;
+}> {
+    fetchResult: any;
+    confirm: (result: {
+        confirmed: boolean;
+    }) => Promise<Status>;
+    constructor(fetchResult: any, confirm: (result: {
+        confirmed: boolean;
+    }) => Promise<Status>);
+}
+
+declare class ShowSign extends FlowModal<{
+    confirmed: boolean;
+}> {
+    fetchResult: any;
+    confirm: (result: {
+        confirmed: boolean;
+    }) => Promise<Status>;
+    constructor(fetchResult: any, confirm: (result: {
+        confirmed: boolean;
+    }) => Promise<Status>);
+}
+
 declare enum ExecutionState {
     RUNNING = 0,
     LOADING = 1,
@@ -1720,6 +1852,10 @@ type TExecutionEnvironment = {
     window: Window;
     document: Document;
     headers: any;
+    properties?: {
+        taskName: string;
+        processName: string;
+    };
 };
 declare class Execution extends EventEmitter$1<{
     confirm: null;
@@ -1736,6 +1872,7 @@ declare class Execution extends EventEmitter$1<{
     private _currentStep;
     private _stepCount;
     readonly notifications: Notifications;
+    private lastModalReturn;
     constructor(environment: TExecutionEnvironment);
     protected formsById: {
         E: Map<string, Form>;
@@ -1779,9 +1916,12 @@ declare class Execution extends EventEmitter$1<{
     doBack(): Promise<false | undefined>;
     doConfirm(status?: Status): Promise<boolean | FlowModal<any> | Field>;
     doFree(): Promise<TApiaApiAxiosResponse<(TFetchTaskActionResponse & ResponseSysMessages) | null> | null>;
-    doNext(): Promise<boolean | Field<TApiaFieldCommonProperties, TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, {
+    doNext(result?: {
+        confirmed: boolean;
+        signed: boolean;
+    }): Promise<boolean | Field<TApiaFieldCommonProperties, TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, {
         definition: Omit<TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, "properties">;
-    }> | undefined>;
+    }> | ShowSignSelection | undefined>;
     doPrint(): Promise<void>;
     doSave(): Promise<TApiaApiAxiosResponse<(TFetchTaskActionResponse & ResponseSysMessages) | null> | undefined>;
     getStepTitle(step: number): {
@@ -1792,6 +1932,8 @@ declare class Execution extends EventEmitter$1<{
     viewDocs(): Promise<(Record<string, unknown> & ResponseSysMessages) | undefined>;
     setStepTitle(stepNumber: number, stepTitle: string): void;
     validate(): Promise<true | Field>;
+    setLastModalReturn(value: string[]): void;
+    getLastModalReturn(): string[];
     private fireEvents;
 }
 
@@ -2124,7 +2266,7 @@ declare class ActionsController {
 
 declare class ApiaForm implements IApiaForm {
     #private;
-    execution: Execution;
+    private execution;
     constructor(execution: Execution, form: Form);
     getFrmParent(): string;
     getFrmId(): string | null;
@@ -2156,16 +2298,20 @@ declare abstract class ApiaField<Props extends TApiaFieldCommonProperties = TApi
     isInGrid(): boolean;
 }
 
+interface TTextFieldProperties extends TApiaFieldCommonProperties {
+    value?: string;
+}
 interface IButtonField extends IApiaField {
     fireClickEvent(): void;
     getValue(): string | null;
 }
-declare class ButtonField extends ApiaField implements IButtonField {
+declare class ButtonField extends ApiaField<TTextFieldProperties> implements IButtonField {
     #private;
     constructor(execution: Execution, field: Button);
     fireClickEvent(): void;
     getValue(): string | null;
     clearValue(): void;
+    setValue(value: string): void;
 }
 
 type TEditorField = IApiaField;
@@ -2283,10 +2429,11 @@ declare class LinkField extends ApiaField implements ILinkField {
 interface ITextField extends IApiaField {
     getLabel(): void;
 }
-declare class TextField extends ApiaField implements ITextField {
+declare class TextField extends ApiaField<TTextFieldProperties> implements ITextField {
     #private;
     constructor(execution: Execution, field: Field);
     getLabel(): void;
+    setValue(value: string): void;
 }
 
 declare class GridField extends ApiaField<TApiaGridProperties> {
@@ -2421,7 +2568,7 @@ declare class Editor extends TranslatableField<TApiaEditorProperties, string> {
     protected isValidValue(): boolean;
 }
 
-declare class File$1 extends TranslatableField<TApiaFileProperties> {
+declare class File$1 extends FieldWithAttribute<TApiaFileProperties> {
     uploader: FormsUploader;
     init(form: Form): Promise<void>;
     validate(): Promise<boolean>;
@@ -2705,6 +2852,7 @@ declare class ModalInput extends FieldWithAttribute<TApiaInputProperties, ModalI
     setValueFromInputWrite(value: string): Promise<void>;
     setValueFromModalSelection(rowId: string): Promise<void>;
     validate(): Promise<boolean>;
+    setValue(newValue: any, options?: SetValueOptions): Promise<boolean>;
     protected getSynchronizePostConfiguration(value: ModalInputValue): IApiaApiPostConfig<any>;
 }
 
@@ -3191,122 +3339,5 @@ declare const parseXml: <T = Record<string, unknown>>(xml: XMLDocument | string)
 
 declare function parseFakeJSON<T extends Record<string, unknown>>(str: string): T;
 
-type TCheckWizardResponse = {
-    url: string;
-};
-type TFetchConfirmPathResponse = {
-    onClose?: string;
-    sysMessages?: {
-        message?: {
-            text: string;
-        };
-    };
-    pathSelection?: boolean | null;
-    groupSelection?: boolean | null;
-    load?: TApiaLoadForm & {
-        type: 'form' | 'text' | 'table' | 'function';
-        canClose: boolean;
-        text?: {
-            closeAll: string;
-            title: string;
-            addClass: string;
-            label: string;
-            content?: string;
-        };
-    };
-    actions?: {
-        action: {
-            toDo: 'functionTimedCall';
-            param: [number, string];
-        };
-    };
-};
-type TItemTreeObj = {
-    id: string;
-    name: string;
-    level: number;
-    value: boolean;
-    type: TPathType;
-    isOn: boolean;
-};
-type TPathType = 'OR' | 'XOR' | 'AND';
-
-declare class ShowPathSelection extends FlowModal<{
-    confirmed: boolean;
-    path: string;
-}> {
-    fetchResult: TApiaLoadForm['form'];
-    confirm: (result: {
-        confirmed: boolean;
-        path: string;
-    }) => Promise<Status | FlowModal<any>>;
-    state: {
-        disabledParents: TItemTreeObj | TItemTreeObj[] | null;
-        groupSelectionObj: TFetchConfirmPathResponse | null;
-    };
-    constructor(fetchResult: TApiaLoadForm['form'], confirm: (result: {
-        confirmed: boolean;
-        path: string;
-    }) => Promise<Status | FlowModal<any>>);
-    setDisabledParent(treeItem: TItemTreeObj): void;
-    clearPaths(): void;
-    showGroupsSelection(fetchConfirmPathResponse: TFetchConfirmPathResponse): void;
-    updateDisabledList(itemObj: TItemTreeObj, itemArr: TItemTreeObj[]): TItemTreeObj[];
-}
-
-declare class ShowPoolSelection extends FlowModal<{
-    confirmed: boolean;
-    group: string;
-}> {
-    fetchResult: TApiaLoadForm['form'];
-    confirm: (result: {
-        confirmed: boolean;
-        group: string;
-    }) => Promise<Status>;
-    constructor(fetchResult: TApiaLoadForm['form'], confirm: (result: {
-        confirmed: boolean;
-        group: string;
-    }) => Promise<Status>);
-}
-
-declare class ShowSignSelection extends FlowModal<{
-    confirmed: boolean;
-    signed: boolean;
-}> {
-    fetchResult: any;
-    confirm: (result: {
-        confirmed: boolean;
-        signed: boolean;
-    }) => Promise<Status>;
-    constructor(fetchResult: any, confirm: (result: {
-        confirmed: boolean;
-        signed: boolean;
-    }) => Promise<Status>);
-}
-
-declare class ShowConfirmMessage extends FlowModal<{
-    confirmed: boolean;
-}> {
-    fetchResult: any;
-    confirm: (result: {
-        confirmed: boolean;
-    }) => Promise<Status>;
-    constructor(fetchResult: any, confirm: (result: {
-        confirmed: boolean;
-    }) => Promise<Status>);
-}
-
-declare class ShowSign extends FlowModal<{
-    confirmed: boolean;
-}> {
-    fetchResult: any;
-    confirm: (result: {
-        confirmed: boolean;
-    }) => Promise<Status>;
-    constructor(fetchResult: any, confirm: (result: {
-        confirmed: boolean;
-    }) => Promise<Status>);
-}
-
 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 };
 //# sourceMappingURL=index.d.ts.map