@apia/execution 4.0.20 → 4.0.24

package/dist/index.d.ts

@@ -450,18 +450,14 @@ type TCusCmpStateRequest = {
         type: 'RELOAD' | 'FIRE';
         content: string;
     }[];
-    additional?: {
-        text: string;
-    };
+    additional?: string;
+    result?: any;
 };
 type TCustomComponentDefaultResponse = {
     processResult?: {
         state: TCusCmpStateRequest;
     };
-    state?: TCusCmpStateRequest;
-    ajaxUpdated?: {
-        text: string;
-    };
+    ajaxUpdated?: string;
 };
 type TCustomComponentDefinition = {
     name: string;
@@ -609,6 +605,7 @@ declare abstract class FieldWithAttribute<FieldProps extends TApiaFieldWithAttri
     protected getSynchronizeUrl(params?: Record<string, unknown>): string;
     protected processSynchronizeError(e: unknown): void;
     protected synchronize(newValue: ValueType): Promise<boolean>;
+    protected hasValue(): boolean;
     protected isValidValue(): boolean;
     validate(): Promise<boolean>;
     setError(err: string): void;
@@ -633,18 +630,33 @@ declare class CustomComponent {
     getAdditional<T>(): DeepReadonly<T>;
     init(form: Form): Promise<void>;
     private parseStateObject;
-    processResult(res?: TCustomComponentDefaultResponse | null): Promise<void>;
+    processResult<Result extends Record<string, unknown> = Record<string, unknown>>(res?: TCustomComponentDefaultResponse | null): Promise<(Result & {
+        success: boolean;
+    }) | undefined>;
     protected getScriptEventParams(fncParams: TFncParams[]): unknown[];
     protected fireScriptEvents(event: ComponentEvent): Promise<boolean>;
-    fireEvent(evtName: string): Promise<void>;
+    fireEvent(evtName: string): Promise<boolean>;
     getProperty(prpName: string): any;
     private postMessage;
-    setStringValue(attName: string, value: string): Promise<void>;
+    setStringValue(attName: string, value: string): Promise<boolean>;
     getStringValue(attName: string): string;
     getValue(attName: string, index?: number): any;
-    setValue(attName: string, value: any, index: number): Promise<void>;
-    setProperty(prpName: string, value: any): Promise<void>;
-    sendMessage(payload: any): Promise<void>;
+    getValues(attName: string): any[];
+    removeIndex(attName: string, index: number): Promise<boolean>;
+    setValue(attName: string, value: any, index: number): Promise<boolean>;
+    setProperty(prpName: string, value: any): Promise<boolean>;
+    sendMessage<T extends Record<string, unknown> = Record<string, unknown>>(payload: any): Promise<(T & {
+        success: boolean;
+    }) | undefined>;
+    upload(attName: string, file: File, options?: {
+        onUploadProgress?: (percent: number) => unknown;
+        params?: Record<string, any>;
+    } & Pick<AxiosRequestConfig<any>, 'signal'>): Promise<({
+        index: number;
+        fileName: string;
+    } & {
+        success: boolean;
+    }) | undefined>;
 }
 
 declare class Form extends WithProperties<TApiaFormProperties> {
@@ -901,6 +913,7 @@ type TProcess = {
  * nombre.
  */
 declare function returnExactlyTheSame(defaultParameters: Record<string, unknown>): Record<string, unknown>;
+declare function isOneClickUploadEnabled(oneClickUploadProp?: boolean): string | boolean;
 declare const parseFileDefinition: (execution: Execution, fileDefinition: TFileUploaded | TUploaderFileInfo, isSignRequired: boolean) => TUploaderFileInfo;
 type TOnUploadProgress = (progress: number) => void;
 declare class UploaderApi extends EventEmitter$1<{
@@ -924,7 +937,7 @@ declare class UploaderApi extends EventEmitter$1<{
     onTranslateUpload(conf: {
         langId: number;
         translatingFile: TUploaderFileInfo;
-    }): Promise<void>;
+    }, files?: File[]): Promise<void>;
     onVersionUpload(file: TUploaderFileInfo, conf?: {
         newFiles?: File[];
         langId?: number;
@@ -1357,7 +1370,7 @@ declare class FormsUploader extends UploaderApi {
     execution: Execution;
     type: 'E' | 'P';
     modalConfig: TModalConfig;
-    private field;
+    field: File$1;
     constructor(execution: Execution, type: 'E' | 'P', modalConfig: TModalConfig, field: File$1);
     isEditionMode: boolean | undefined;
     index(): number;
@@ -2688,6 +2701,7 @@ type ModalInputValue = {
 declare class ModalInput extends FieldWithAttribute<TApiaInputProperties, ModalInputValue> {
     constructor({ value, ...definition }: TApiaModalInputDefinition);
     fireEvent(eventName: InputEvents): Promise<boolean>;
+    protected hasValue(): boolean;
     setValueFromInputWrite(value: string): Promise<void>;
     setValueFromModalSelection(rowId: string): Promise<void>;
     validate(): Promise<boolean>;
@@ -2696,6 +2710,7 @@ declare class ModalInput extends FieldWithAttribute<TApiaInputProperties, ModalI
 
 declare class Multiple extends FieldWithAttribute<TApiaMultipleProperties, string[]> {
     constructor({ possibleValue, value, ...definition }: TApiaMultipleDefinition);
+    protected hasValue(): boolean;
     setValue(newValue: string[], options?: Partial<{
         comparator: Comparator$1<any>;
         format: 'd/m/Y' | 'apia';
@@ -2736,6 +2751,7 @@ declare class Tree extends FieldWithAttribute<TApiaTreeProperties, TTreeValue[],
     constructor({ possibleValue, ...props }: TApiaTreeDefinition);
     protected getSynchronizePostConfiguration(value: TTreeValue[]): IApiaApiPostConfig<any>;
     fireEvent(eventName: TreeEvents): Promise<boolean>;
+    protected hasValue(): boolean;
     setProperty<K extends keyof TApiaTreeProperties>(propName: K, propValue: TApiaTreeProperties[K]): void;
     init(form: Form): Promise<void>;
     protected isValidValue(): boolean;
@@ -3173,6 +3189,8 @@ declare function getLabel(execution: Execution, label: string, replacers?: Parti
 
 declare const parseXml: <T = Record<string, unknown>>(xml: XMLDocument | string) => T;
 
+declare function parseFakeJSON<T extends Record<string, unknown>>(str: string): T;
+
 type TCheckWizardResponse = {
     url: string;
 };
@@ -3290,5 +3308,5 @@ declare class ShowSign extends FlowModal<{
     }) => 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, isXmlResponse, makeApiaUrl, 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 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