@apia/execution 4.0.29 → 4.0.31

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -385,6 +385,7 @@ interface TApiaMessage {
385
385
  label?: string;
386
386
  title: string;
387
387
  text: string;
388
+ type?: number;
388
389
  }
389
390
  type ResponseSysMessages = {
390
391
  sysMessages?: {
@@ -515,6 +516,7 @@ type SetValueOptions = Partial<{
515
516
  format: 'd/m/Y' | 'apia';
516
517
  markAsDirty: boolean;
517
518
  synchronize: boolean;
519
+ force: boolean;
518
520
  }>;
519
521
  type FireEventParameters = Record<string, unknown>;
520
522
  type FieldValidationState = {
@@ -597,6 +599,9 @@ declare class WithProperties<Props extends Record<string, any>> {
597
599
  setParentGrid(grid: Grid): this;
598
600
  }
599
601
 
602
+ type TFireEventOptions = {
603
+ force?: boolean;
604
+ };
600
605
  declare class Attribute {
601
606
  readonly id: string;
602
607
  readonly name: string;
@@ -609,10 +614,11 @@ declare abstract class FieldWithAttribute<FieldProps extends TApiaFieldWithAttri
609
614
  protected lastSynchronizationValue: ValueType | null;
610
615
  readonly attribute: Attribute;
611
616
  constructor({ attId, attName, attLabel, valueType, value, ...definition }: TApiaFieldWithAttributeBaseProps<FieldProps>);
612
- fireEvent(eventName: string): Promise<boolean>;
617
+ fireEvent(eventName: string, options?: TFireEventOptions): Promise<boolean>;
613
618
  protected getInitialValue({ value, }: TApiaFieldWithAttributeBaseProps<FieldProps>): Promise<ValueType>;
614
619
  getValidationState(): FieldValidationState;
615
620
  getValue(): ValueType;
621
+ protected canSetValue(newValue: ValueType): boolean;
616
622
  setValue(newValue: ValueType, options?: SetValueOptions): Promise<boolean>;
617
623
  protected getSynchronizePostConfiguration(value: ValueType): IApiaApiPostConfig<any>;
618
624
  protected getSynchronizeUrl(params?: Record<string, unknown>): string;
@@ -626,1887 +632,2702 @@ declare abstract class FieldWithAttribute<FieldProps extends TApiaFieldWithAttri
626
632
  init(form: Form): Promise<void>;
627
633
  }
628
634
 
629
- type TCustomComponentState = {
630
- isLoading: boolean;
631
- attributes: Record<string, any[]>;
632
- properties: Record<string, any>;
633
- additional: any;
634
- component: any;
635
- };
636
- declare class CustomComponent {
637
- #private;
638
- execution: Execution;
639
- readonly definition: TCustomComponentDefinition;
640
- form: Form;
641
- private _state;
642
- constructor(execution: Execution, definition: TCustomComponentDefinition);
643
- get state(): DeepReadonly<TCustomComponentState>;
644
- getAdditional<T>(): DeepReadonly<T>;
645
- init(form: Form): Promise<void>;
646
- private parseStateObject;
647
- processResult<Result extends Record<string, unknown> = Record<string, unknown>>(res?: TCustomComponentDefaultResponse | null): Promise<(Result & {
648
- success: boolean;
649
- }) | undefined>;
650
- protected getScriptEventParams(fncParams: TFncParams[]): unknown[];
651
- protected fireScriptEvents(event: ComponentEvent): Promise<boolean>;
652
- fireEvent(evtName: string): Promise<boolean>;
653
- getProperty(prpName: string): any;
654
- private postMessage;
655
- setStringValue(attName: string, value: string): Promise<boolean>;
656
- getStringValue(attName: string): string;
657
- getValue(attName: string, index?: number): any;
658
- getValues(attName: string): any[];
659
- removeIndex(attName: string, index: number): Promise<boolean>;
660
- setValue(attName: string, value: any, index: number): Promise<boolean>;
661
- setProperty(prpName: string, value: any): Promise<boolean>;
662
- sendMessage<T extends Record<string, unknown> = Record<string, unknown>>(payload: any): Promise<(T & {
663
- success: boolean;
664
- }) | undefined>;
665
- download(attName: string, index: number): Promise<void>;
666
- upload(attName: string, file: File, options?: {
667
- onUploadProgress?: (percent: number) => unknown;
668
- params?: Record<string, any>;
669
- } & Pick<AxiosRequestConfig<any>, 'signal'>): Promise<({
670
- index: number;
671
- fileName: string;
672
- } & {
673
- success: boolean;
674
- }) | undefined>;
675
- setState<K extends keyof TCustomComponentState>(prop: K, value: TCustomComponentState[K]): void;
676
- }
635
+ declare const FieldConstants: Readonly<{
636
+ TYPE_INPUT: "input";
637
+ TYPE_SELECT: "select";
638
+ TYPE_RADIO: "radio";
639
+ TYPE_CHECK: "check";
640
+ TYPE_BUTTON: "button";
641
+ TYPE_AREA: "area";
642
+ TYPE_LABEL: "label";
643
+ TYPE_TITLE: "title";
644
+ TYPE_FILE: "file";
645
+ TYPE_MULTIPLE: "multiple";
646
+ TYPE_HIDDEN: "hidden";
647
+ TYPE_PASSWORD: "password";
648
+ TYPE_GRID: "grid";
649
+ TYPE_IMAGE: "image";
650
+ TYPE_HREF: "href";
651
+ TYPE_EDITOR: "editor";
652
+ TYPE_TREE: "tree";
653
+ TYPE_CAPTCHA: "captcha";
654
+ PROPERTY_NAME: "name";
655
+ PROPERTY_SIZE: "size";
656
+ PROPERTY_READONLY: "readonly";
657
+ PROPERTY_DISABLED: "disabled";
658
+ PROPERTY_MODAL_DISABLED: "modalDisabled";
659
+ PROPERTY_FONT_COLOR: "fontColor";
660
+ PROPERTY_VALUE: "value";
661
+ PROPERTY_REQUIRED: "required";
662
+ PROPERTY_COLSPAN: "colspan";
663
+ PROPERTY_ROWSPAN: "rowspan";
664
+ PROPERTY_MODAL: "modal";
665
+ PROPERTY_ROWS: "thisRows";
666
+ PROPERTY_BOLD: "bold";
667
+ PROPERTY_UNDERLINED: "underlined";
668
+ PROPERTY_ALIGNMENT: "alignment";
669
+ PROPERTY_IMAGE: "imageUrl";
670
+ PROPERTY_COL_WIDTH: "colWidth";
671
+ PROPERTY_GRID_HEIGHT: "gridHeight";
672
+ PROPERTY_HIDE_GRID_BTN: "hideGridButtons";
673
+ PROPERTY_VISIBILITY_HIDDEN: "visibilityHidden";
674
+ PROPERTY_TRANSIENT: "transient";
675
+ PROPERTY_GRID_TITLE: "gridTitle";
676
+ PROPERTY_GRID_FORM: "gridForm";
677
+ PROPERTY_TOOLTIP: "tooltip";
678
+ PROPERTY_VALUE_COLOR: "valueColor";
679
+ PROPERTY_INPUT_AS_TEXT: "inputAsText";
680
+ PROPERTY_NO_DOWNLOAD: "noDownload";
681
+ PROPERTY_NO_ERASE: "noErase";
682
+ PROPERTY_NO_LOCK: "noLock";
683
+ PROPERTY_NO_HISTORY: "noHistory";
684
+ PROPERTY_NO_MODIFY: "noModify";
685
+ PROPERTY_ALLOW_EDITION: "allowEdition";
686
+ PROPERTY_HIDE_SIGN_ICONS: "hideSignButtons";
687
+ PROPERTY_URL: "url";
688
+ PROPERTY_GRID_HIDE_BTN_ORDER: "hideOrderButton";
689
+ PROPERTY_GRID_HIDE_BTN_INCLUDE: "hideIncludeButton";
690
+ PROPERTY_REGEXP_MESSAGE: "regExpMessage";
691
+ PROPERTY_PAGED_GRID: "paged";
692
+ PROPERTY_PAGED_GRID_SIZE: "pagedGridSize";
693
+ PROPERTY_GRID_ALTER_IN_LAST_PAGE: "alterOnlyLastPage";
694
+ PROPERTY_GRID_PRINT_HORIZONTAL: "printHorizontal";
695
+ PROPERTY_STORE_MODAL_QUERY_RESULT: "storeMdlQryResult";
696
+ PROPERTY_INCLUDE_FIRST_ROW: "includeFirstRow";
697
+ PROPERTY_MAX_REG_GRID: "maxRecords";
698
+ PROPERTY_GRID_LABEL: "gridColTitle";
699
+ PROPERTY_GRID_QUERY: "gridQuery";
700
+ PROPERTY_HIDE_DOC_PERMISSIONS: "hideDocPermissions";
701
+ PROPERTY_VERIFY_SIGNATURE_ONLY: "verifySignatureOnly";
702
+ PROPERTY_GRID_HIDE_BTN_ADD: "hideAddButton";
703
+ PROPERTY_GRID_HIDE_BTN_DEL: "hideDelButton";
704
+ PROPERTY_HIDE_DOC_UPLOAD: "hideDocUpload";
705
+ PROPERTY_HIDE_DOC_DOWNLOAD: "hideDocDownload";
706
+ PROPERTY_HIDE_DOC_ERASE: "hideDocErase";
707
+ PROPERTY_HIDE_DOC_LOCK: "hideDocLock";
708
+ PROPERTY_HIDE_DOC_HISTORY: "hideDocHistory";
709
+ PROPERTY_HIDE_DOC_SIGN: "hideSignButtons";
710
+ PROPERTY_DISPLAY_NONE: "displayNone";
711
+ PROPERTY_DONT_BREAK_RADIO: "dontBreakRadio";
712
+ PROPERTY_CHECKED: "checked";
713
+ PROPERTY_FILE_PREVIEW: "filePreview";
714
+ PROPERTY_NOT_PRINT: "noPrint";
715
+ PROPERTY_SELECT_PARENT: "selParent";
716
+ PROPERTY_HEIGHT: "height";
717
+ PROPERTY_MULTISELECT: "multiselect";
718
+ PROPERTY_SEL_PARENT: "selParent";
719
+ PROPERTY_PARENT_ICON: "parentIcon";
720
+ PROPERTY_LEAF_ICON: "leafIcon";
721
+ PROPERTY_CSS_CLASS: "cssClass";
722
+ PROPERTY_DOC_TYPE: "docType";
723
+ PROPERTY_HIDE_DOC_METADATA: "hideDocMetadata";
724
+ PROPERTY_TRANSLATION_REQUIRED: "reqTrad";
725
+ PROPERTY_SIGNATURE_REQUIRED: "reqSign";
726
+ PROPERTY_SHOW_TOOLTIP_AS_HELP: "tooltipHelp";
727
+ PROPERTY_DOCUMENT_MONITOR_DEF: "documentMonitorDef";
728
+ PROPERTY_DOCUMENT_MONITOR_CUS: "documentMonitorCus";
729
+ PROPERTY_DOCUMENT_SHOW_FOLD_TREE_BTN: "fileShwFoldTreeBtn";
730
+ PROPERTY_DOCUMENT_SHOW_FOLD_TREE_STR: "fileShwFoldTreeStr";
731
+ PROPERTY_DOCUMENT_NO_ALLOW_DRAG_DROP: "fileNoAllwDnD";
732
+ PROPERTY_DOCUMENT_NO_SHOW_MODAL: "fileDntShwDocMdlOnDrop";
733
+ PROPERTY_DOCUMENT_SHOW_DESC: "fileShowDesc";
734
+ PROPERTY_DOCUMENT_DEFAULT_FOLDER: "fileDefFolder";
735
+ PROPERTY_DOCUMENT_ROOT_FOLDER: "fileRootFolder";
736
+ PROPERTY_DOCUMENT_EXP_DATE: "fileExpDate";
737
+ PROPERTY_DOCUMENT_DNT_SHW_DOC_MON: "fileNotShowDocMon";
738
+ PROPERTY_DOCUMENT_COLLAPSE_PERM: "fileCollapsePermission";
739
+ PROPERTY_DOCUMENT_COLLAPSE_META: "fileCollapseMetadata";
740
+ PROPERTY_DOCUMENT_COLLAPSE_FLD_STC: "fileCollapseFldStrc";
741
+ WRONG_ATT_TYPE_ERROR: "Component does not support attributes of type <TOK>. Contact system administrator";
742
+ STORE_KEY_FIELD: "field";
743
+ STORE_KEY_FORM: "form";
744
+ PROPERTY_ARIA_DESCRIPTION: "ariaDescription";
745
+ PROPERTY_ARIA_LABEL: "ariaLabel";
746
+ PROPERTY_ALT: "alt";
747
+ PROPERTY_AUTO_COMPLETE: "autoComplete";
748
+ PROPERTY_AUTO_FOCUS: "autoFocus";
749
+ PROPERTY_INPUT_TYPE: "inputType";
750
+ PROPERTY_PLACE_HOLDER: "placeHolder";
751
+ PROPERTY_TITLE: "title";
752
+ }>;
677
753
 
678
- declare class Form extends WithProperties<TApiaFormProperties> {
679
- execution: Execution;
680
- fields: TApiaFieldBaseDefinition<Record<string, any>>[];
681
- state: {
682
- isMarkedToSign: boolean;
683
- };
684
- protected _customComponents: Map<string, CustomComponent>;
685
- protected fieldsById: Map<string, Field<Record<string, any>, TApiaFieldBaseDefinition<Record<string, any>>, {
686
- definition: Omit<TApiaFieldBaseDefinition<Record<string, any>>, "properties">;
687
- }>>;
688
- protected fieldsByName: Map<string, Field<Record<string, any>, TApiaFieldBaseDefinition<Record<string, any>>, {
689
- definition: Omit<TApiaFieldBaseDefinition<Record<string, any>>, "properties">;
690
- }>>;
691
- protected fieldsByAttributeId: Map<string | number, FieldWithAttribute<Record<string, any>, any, TApiaFieldWithAttributeBaseProps<Record<string, any>>>>;
692
- protected fieldsByAttributeName: Map<string, FieldWithAttribute<Record<string, any>, any, TApiaFieldWithAttributeBaseProps<Record<string, any>>>>;
693
- protected fieldsGroups: Map<string, Grid>;
694
- definition: TApiaForm;
695
- constructor(execution: Execution, definition: TApiaForm);
696
- get allFields(): Field<Record<string, any>, TApiaFieldBaseDefinition<Record<string, any>>, {
697
- definition: Omit<TApiaFieldBaseDefinition<Record<string, any>>, "properties">;
698
- }>[];
699
- get customComponents(): Map<string, CustomComponent>;
700
- closeForm(): void;
754
+ declare const FormConstants: Readonly<{
755
+ PROPERTY_FORM_HIDDEN: "frmHidden";
756
+ PROPERTY_FORM_HIGHLIGHT: "frmHighlight";
757
+ PROPERTY_FORM_CLOSED: "prpFrmClosed";
758
+ PROPERTY_FORM_TAB: "frmTab";
759
+ PROPERTY_FORM_DONT_FIRE: "frmDontFire";
760
+ PROPERTY_FORM_READONLY: "readOnly";
761
+ }>;
762
+
763
+ interface IIProperty {
764
+ [key: string]: string;
765
+ }
766
+ interface IApiaFunctions {
767
+ getLastModalReturn: () => string[];
768
+ getModalReturn: () => string[];
769
+ getModalValue: () => string;
770
+ getModalShowValue: () => string;
771
+ setLastModalReturn: (value: string[]) => void;
772
+ getModalSelectedRow: () => string[];
773
+ getForm(frmName: string, frmType?: string): IApiaForm | null;
774
+ getAllForms(): IApiaForm[];
775
+ getEntityForm(frmName: string): IApiaForm | null;
776
+ getProcessForm(frmName: string): IApiaForm | null;
777
+ getAttField(attType: 'P' | 'E', attId: string): IApiaField | IApiaField[] | undefined;
778
+ setStepTitle(stepNumber: number, stepTitle: string): void;
779
+ getCurrentStep(): number | null;
780
+ getCurrentTaskName(): string | null;
781
+ getCurrentProcessName(): string | null;
782
+ getRootPath(): string | null;
783
+ getCurrentLanguageCode(): string | null;
784
+ toJSNumber(value: string): number | string;
785
+ toApiaNumber(value: number): number | string;
786
+ openTab(title: string, url: string): void;
787
+ showMessage(text: string): void;
788
+ showConfirm(text: string, title: string, callbackFn: (win: boolean) => unknown): void;
789
+ }
790
+ interface IApiaForm {
791
+ getFrmId(): string | null;
792
+ getFrmParent(): string;
793
+ getFormName(): string;
794
+ getFormTitle(): string;
701
795
  openForm(): void;
702
- getField(field: string, index?: number): Field<TApiaFieldCommonProperties, TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, {
703
- definition: Omit<TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, "properties">;
704
- }> | Field<Record<string, any>, TApiaFieldBaseDefinition<Record<string, any>>, {
705
- definition: Omit<TApiaFieldBaseDefinition<Record<string, any>>, "properties">;
706
- }> | FieldWithAttribute<Record<string, any>, any, TApiaFieldWithAttributeBaseProps<Record<string, any>>> | Field<TApiaFieldCommonProperties, TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, {
707
- definition: Omit<TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, "properties">;
708
- }>[] | undefined;
709
- getFieldByAttributeId(attId: string | number, index?: number): Field<TApiaFieldCommonProperties, TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, {
710
- definition: Omit<TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, "properties">;
711
- }> | FieldWithAttribute<Record<string, any>, any, TApiaFieldWithAttributeBaseProps<Record<string, any>>> | Field<TApiaFieldCommonProperties, TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, {
712
- definition: Omit<TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, "properties">;
713
- }>[] | undefined;
714
- getFieldByAttributeName(attName: string, index?: number): Field<TApiaFieldCommonProperties, TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, {
715
- definition: Omit<TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, "properties">;
716
- }> | FieldWithAttribute<Record<string, any>, any, TApiaFieldWithAttributeBaseProps<Record<string, any>>> | Field<TApiaFieldCommonProperties, TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, {
717
- definition: Omit<TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, "properties">;
718
- }>[] | undefined;
719
- getFieldById(id: string | number, index?: number): Field<TApiaFieldCommonProperties, TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, {
720
- definition: Omit<TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, "properties">;
721
- }> | Field<Record<string, any>, TApiaFieldBaseDefinition<Record<string, any>>, {
722
- definition: Omit<TApiaFieldBaseDefinition<Record<string, any>>, "properties">;
723
- }> | Field<TApiaFieldCommonProperties, TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, {
724
- definition: Omit<TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, "properties">;
725
- }>[] | undefined;
726
- getFieldByName(name: string, index?: number): Field | Field[] | undefined;
727
- protected getHiddenFields(): Field<Record<string, any>, TApiaFieldBaseDefinition<Record<string, any>>, {
728
- definition: Omit<TApiaFieldBaseDefinition<Record<string, any>>, "properties">;
729
- }>[];
730
- markFormToSign(): Promise<void>;
731
- viewSigns(): Promise<TSignaturesData | undefined>;
732
- private cucCmpByAttId;
733
- private cucCmpByFldId;
734
- private cucCmpByAttName;
735
- private mustRenderFields;
736
- getCustomComponentByFldId(fldId: number): CustomComponent | undefined;
737
- getCustomComponentByAttId(attId: number): CustomComponent | undefined;
738
- getCustomComponentByAttName(attName: string): CustomComponent | undefined;
739
- addFieldToRender(fldId: string, fldIndex?: number): void;
740
- markFieldAsRendered(fldId: string, fldIndex?: number): void;
741
- init(): Promise<void>;
742
- protected getScriptEventParams(fncParams: TFncParams[]): Promise<unknown[]>;
743
- fireScriptEvent(eventName: TFormEventName): Promise<boolean>;
744
- validate(): Promise<true | Field>;
796
+ closeForm(): void;
797
+ getProperty<K extends keyof typeof FormConstants>(name: (typeof FormConstants)[K]): unknown;
798
+ setProperty<K extends keyof typeof FormConstants>(name: (typeof FormConstants)[K], value: unknown): void;
799
+ getField(fld: number | string, index?: number): IApiaField | undefined;
800
+ getFieldColumn(fldName: string): IApiaField[];
801
+ getAllFields(): IApiaField[];
802
+ clearForm(clearReadonlyFields: boolean, deleteGridsRows: boolean): void;
745
803
  }
746
-
747
- type TTranslationState = {
748
- id: string;
804
+ interface IApiaField<Props extends typeof FieldConstants = typeof FieldConstants> {
805
+ get fldType(): TApiaFieldType;
806
+ get fldId(): string;
807
+ /**
808
+ * Assigns a new value to the property whoose name's correspond to that determined by the name paremeter.
809
+ */
810
+ setProperty<K extends keyof Props>(name: Props[K], value: unknown): void;
811
+ /**
812
+ * Returns the current value of the property determined by the name in the paremeter.
813
+ */
814
+ getProperty<K extends keyof Props>(name: Props[K]): unknown;
815
+ /**
816
+ * Sets the focus on the field if possible.
817
+ */
818
+ setFocus(): void;
819
+ /**
820
+ * Returns true if the field is part of a grid.
821
+ */
822
+ isInGrid(): boolean;
823
+ }
824
+ type TApiaFieldType = 'area' | 'button' | 'captcha' | 'check' | 'editor' | 'file' | 'grid' | 'hidden' | 'href' | 'image' | 'input' | 'label' | 'multiple' | 'password' | 'radio' | 'select' | 'title' | 'tree' | 'form';
825
+ type PossibleValue = {
826
+ value: string | number;
749
827
  label: string;
750
- hasChanged: boolean;
751
- isTranslated: boolean;
752
- remoteValue?: string;
753
- tempValue: string;
828
+ selected?: boolean;
754
829
  };
755
830
 
756
- declare class Translation {
757
- execution: Execution;
758
- state: TTranslationState;
759
- constructor(execution: Execution, state: Pick<TTranslationState, 'id' | 'label' | 'isTranslated'>);
760
- cancelTranslation(): void;
761
- readTranslations(url: string): Promise<void>;
762
- reset(): void;
763
- deleteTranslation(): void;
764
- setTempValue(str: string): void;
765
- submitTranslation(value: string, url: string): void;
766
- get langId(): string;
767
- get value(): string;
831
+ declare global {
832
+ interface Window {
833
+ lastModalReturn: string[];
834
+ }
835
+ }
836
+ declare class ApiaFunctions implements IApiaFunctions {
837
+ #private;
838
+ constructor(execution: Execution);
839
+ toJSNumber(_value: string): number | string;
840
+ toApiaNumber(_value: number): number | string;
841
+ openTab(_title: string, _url: string): void;
842
+ showMessage(_text: string): void;
843
+ showConfirm(_text: string, _title: string, _callbackFn: (win: boolean) => unknown): void;
844
+ getFormByType(frmName: string, frmType: TFrmParent): IApiaForm | null;
845
+ admEntity(entName: string, entNum?: number, parameters?: string, width?: number, height?: number): void;
846
+ clearMessages(): void;
847
+ clickActionButton(button: number): void;
848
+ disableActionButton(id: number): void;
849
+ enableActionButton(id: number): void;
850
+ getAllForms(): IApiaForm[];
851
+ getAllFormsByType(type: 'P' | 'E'): IApiaForm[];
852
+ getAttField(attType: 'P' | 'E', attId: string): IApiaField | IApiaField[] | undefined;
853
+ getCurrentLanguageCode(): string | null;
854
+ getCurrentProcessName(): string | null;
855
+ getCurrentStep(): number | null;
856
+ getCurrentTaskName(): string | null;
857
+ getEntityForm(frmName: string): IApiaForm | null;
858
+ getForm(frmName: string, frmType?: string): IApiaForm | null;
859
+ getLastModalReturn(): string[];
860
+ getModalReturn(): string[];
861
+ getModalSelectedRow(): string[];
862
+ getModalShowValue(): string;
863
+ getModalValue(): string;
864
+ getProcessForm(frmName: string): IApiaForm | null;
865
+ getRootPath(): string | null;
866
+ hideActionButton(id: number): void;
867
+ isActionButtonDisabled(id: number): boolean;
868
+ isActionButtonHidden(id: number): boolean;
869
+ saveTask(): void;
870
+ setLastModalReturn(value: string[]): void;
871
+ setStepTitle(stepNumber: number, stepTitle: string): void;
872
+ showActionButton(id: number): void;
873
+ viewAdmEntity(entName: string, entNum?: number): void;
768
874
  }
769
875
 
770
- interface InitialTradMap {
771
- [key: string]: boolean;
876
+ declare class ActionsController {
877
+ static CONFIRM: number;
878
+ static NEXT: number;
879
+ static PREVIOUS: number;
880
+ static SIGN: number;
881
+ static SAVE: number;
882
+ static RELEASE: number;
883
+ static DELEGATE: number;
884
+ static SHARE: number;
885
+ static PRINT: number;
886
+ static VIEW_DOCS: number;
887
+ static CLOSE: number;
888
+ static SEND_TO_DESK: number;
889
+ static BTN_CONFIRM: number;
890
+ static BTN_DELEGATE: number;
891
+ static BTN_NEXT: number;
892
+ static BTN_PERV: number;
893
+ static BTN_RELEASE: number;
894
+ static BTN_SAVE: number;
895
+ static BTN_SHARE: number;
896
+ static BTN_SIGN: number;
897
+ private static _instance;
898
+ static get instance(): ActionsController;
899
+ private constructor();
900
+ private buttons;
901
+ private get;
902
+ disable(id: number): void;
903
+ enable(id: number): void;
904
+ hide(id: number): void;
905
+ isDisabled(id: number): boolean;
906
+ isHidden(id: number): boolean;
907
+ show(id: number): void;
772
908
  }
773
- declare abstract class TranslatableField<FieldProps extends TApiaTranslatableFieldProperties = TApiaTranslatableFieldProperties, ValueType = any, FieldDefinition extends TApiaFieldWithAttributeBaseProps<FieldProps> = TApiaFieldWithAttributeBaseProps<FieldProps>> extends FieldWithAttribute<FieldProps, ValueType, FieldDefinition> {
774
- translations: Map<string, Translation>;
775
- selectedLanguageId: string;
776
- isTradLoading: boolean;
777
- definitionTradParsed: InitialTradMap;
778
- constructor(props: TApiaFieldWithAttributeBaseProps<FieldProps>);
779
- private extractTrad;
780
- private getLanguages;
781
- init(form: Form): Promise<void>;
782
- cancelTranslations(): void;
783
- deleteTranslations(): void;
784
- changeLanguage(langId: string): Promise<void>;
785
- getTranslation(id: string): Translation | undefined;
786
- getCurrentTranslation(): Translation | undefined;
787
- getTranslations(): Map<string, Translation>;
788
- submitTranslations(): void;
789
- syncTranslation(): Promise<void>;
790
- validate(): Promise<boolean>;
791
- setValue(newValue: ValueType, options?: Partial<{
792
- comparator: Comparator$1<any>;
793
- format: 'd/m/Y' | 'apia';
794
- markAsDirty: boolean;
795
- synchronize: boolean;
796
- }> | undefined): Promise<boolean>;
909
+
910
+ declare class ApiaForm implements IApiaForm {
911
+ #private;
912
+ constructor(execution: Execution, form: Form);
913
+ getFrmParent(): string;
914
+ getFrmId(): string | null;
915
+ getFormName(): string;
916
+ getFormTitle(): string;
917
+ openForm(): void;
918
+ closeForm(): void;
919
+ getProperty<K extends keyof typeof FormConstants>(name: (typeof FormConstants)[K]): unknown;
920
+ setProperty<K extends keyof typeof FormConstants>(name: (typeof FormConstants)[K], value: unknown): void;
921
+ getCustomComponent(attName: string): CustomComponent | undefined;
922
+ getField(fld: string | number, index?: number): IApiaField | undefined;
923
+ getFieldById(fldId: string): IApiaField<Readonly<{
924
+ TYPE_INPUT: "input";
925
+ TYPE_SELECT: "select";
926
+ TYPE_RADIO: "radio";
927
+ TYPE_CHECK: "check";
928
+ TYPE_BUTTON: "button";
929
+ TYPE_AREA: "area";
930
+ TYPE_LABEL: "label";
931
+ TYPE_TITLE: "title";
932
+ TYPE_FILE: "file";
933
+ TYPE_MULTIPLE: "multiple";
934
+ TYPE_HIDDEN: "hidden";
935
+ TYPE_PASSWORD: "password";
936
+ TYPE_GRID: "grid";
937
+ TYPE_IMAGE: "image";
938
+ TYPE_HREF: "href";
939
+ TYPE_EDITOR: "editor";
940
+ TYPE_TREE: "tree";
941
+ TYPE_CAPTCHA: "captcha";
942
+ PROPERTY_NAME: "name";
943
+ PROPERTY_SIZE: "size";
944
+ PROPERTY_READONLY: "readonly";
945
+ PROPERTY_DISABLED: "disabled";
946
+ PROPERTY_MODAL_DISABLED: "modalDisabled";
947
+ PROPERTY_FONT_COLOR: "fontColor";
948
+ PROPERTY_VALUE: "value";
949
+ PROPERTY_REQUIRED: "required";
950
+ PROPERTY_COLSPAN: "colspan";
951
+ PROPERTY_ROWSPAN: "rowspan";
952
+ PROPERTY_MODAL: "modal";
953
+ PROPERTY_ROWS: "thisRows";
954
+ PROPERTY_BOLD: "bold";
955
+ PROPERTY_UNDERLINED: "underlined";
956
+ PROPERTY_ALIGNMENT: "alignment";
957
+ PROPERTY_IMAGE: "imageUrl";
958
+ PROPERTY_COL_WIDTH: "colWidth";
959
+ PROPERTY_GRID_HEIGHT: "gridHeight";
960
+ PROPERTY_HIDE_GRID_BTN: "hideGridButtons";
961
+ PROPERTY_VISIBILITY_HIDDEN: "visibilityHidden";
962
+ PROPERTY_TRANSIENT: "transient";
963
+ PROPERTY_GRID_TITLE: "gridTitle";
964
+ PROPERTY_GRID_FORM: "gridForm";
965
+ PROPERTY_TOOLTIP: "tooltip";
966
+ PROPERTY_VALUE_COLOR: "valueColor";
967
+ PROPERTY_INPUT_AS_TEXT: "inputAsText";
968
+ PROPERTY_NO_DOWNLOAD: "noDownload";
969
+ PROPERTY_NO_ERASE: "noErase";
970
+ PROPERTY_NO_LOCK: "noLock";
971
+ PROPERTY_NO_HISTORY: "noHistory";
972
+ PROPERTY_NO_MODIFY: "noModify";
973
+ PROPERTY_ALLOW_EDITION: "allowEdition";
974
+ PROPERTY_HIDE_SIGN_ICONS: "hideSignButtons";
975
+ PROPERTY_URL: "url";
976
+ PROPERTY_GRID_HIDE_BTN_ORDER: "hideOrderButton";
977
+ PROPERTY_GRID_HIDE_BTN_INCLUDE: "hideIncludeButton";
978
+ PROPERTY_REGEXP_MESSAGE: "regExpMessage";
979
+ PROPERTY_PAGED_GRID: "paged";
980
+ PROPERTY_PAGED_GRID_SIZE: "pagedGridSize";
981
+ PROPERTY_GRID_ALTER_IN_LAST_PAGE: "alterOnlyLastPage";
982
+ PROPERTY_GRID_PRINT_HORIZONTAL: "printHorizontal";
983
+ PROPERTY_STORE_MODAL_QUERY_RESULT: "storeMdlQryResult";
984
+ PROPERTY_INCLUDE_FIRST_ROW: "includeFirstRow";
985
+ PROPERTY_MAX_REG_GRID: "maxRecords";
986
+ PROPERTY_GRID_LABEL: "gridColTitle";
987
+ PROPERTY_GRID_QUERY: "gridQuery";
988
+ PROPERTY_HIDE_DOC_PERMISSIONS: "hideDocPermissions";
989
+ PROPERTY_VERIFY_SIGNATURE_ONLY: "verifySignatureOnly";
990
+ PROPERTY_GRID_HIDE_BTN_ADD: "hideAddButton";
991
+ PROPERTY_GRID_HIDE_BTN_DEL: "hideDelButton";
992
+ PROPERTY_HIDE_DOC_UPLOAD: "hideDocUpload";
993
+ PROPERTY_HIDE_DOC_DOWNLOAD: "hideDocDownload";
994
+ PROPERTY_HIDE_DOC_ERASE: "hideDocErase";
995
+ PROPERTY_HIDE_DOC_LOCK: "hideDocLock";
996
+ PROPERTY_HIDE_DOC_HISTORY: "hideDocHistory";
997
+ PROPERTY_HIDE_DOC_SIGN: "hideSignButtons";
998
+ PROPERTY_DISPLAY_NONE: "displayNone";
999
+ PROPERTY_DONT_BREAK_RADIO: "dontBreakRadio";
1000
+ PROPERTY_CHECKED: "checked";
1001
+ PROPERTY_FILE_PREVIEW: "filePreview";
1002
+ PROPERTY_NOT_PRINT: "noPrint";
1003
+ PROPERTY_SELECT_PARENT: "selParent";
1004
+ PROPERTY_HEIGHT: "height";
1005
+ PROPERTY_MULTISELECT: "multiselect";
1006
+ PROPERTY_SEL_PARENT: "selParent";
1007
+ PROPERTY_PARENT_ICON: "parentIcon";
1008
+ PROPERTY_LEAF_ICON: "leafIcon";
1009
+ PROPERTY_CSS_CLASS: "cssClass";
1010
+ PROPERTY_DOC_TYPE: "docType";
1011
+ PROPERTY_HIDE_DOC_METADATA: "hideDocMetadata";
1012
+ PROPERTY_TRANSLATION_REQUIRED: "reqTrad";
1013
+ PROPERTY_SIGNATURE_REQUIRED: "reqSign";
1014
+ PROPERTY_SHOW_TOOLTIP_AS_HELP: "tooltipHelp";
1015
+ PROPERTY_DOCUMENT_MONITOR_DEF: "documentMonitorDef";
1016
+ PROPERTY_DOCUMENT_MONITOR_CUS: "documentMonitorCus";
1017
+ PROPERTY_DOCUMENT_SHOW_FOLD_TREE_BTN: "fileShwFoldTreeBtn";
1018
+ PROPERTY_DOCUMENT_SHOW_FOLD_TREE_STR: "fileShwFoldTreeStr";
1019
+ PROPERTY_DOCUMENT_NO_ALLOW_DRAG_DROP: "fileNoAllwDnD";
1020
+ PROPERTY_DOCUMENT_NO_SHOW_MODAL: "fileDntShwDocMdlOnDrop";
1021
+ PROPERTY_DOCUMENT_SHOW_DESC: "fileShowDesc";
1022
+ PROPERTY_DOCUMENT_DEFAULT_FOLDER: "fileDefFolder";
1023
+ PROPERTY_DOCUMENT_ROOT_FOLDER: "fileRootFolder";
1024
+ PROPERTY_DOCUMENT_EXP_DATE: "fileExpDate";
1025
+ PROPERTY_DOCUMENT_DNT_SHW_DOC_MON: "fileNotShowDocMon";
1026
+ PROPERTY_DOCUMENT_COLLAPSE_PERM: "fileCollapsePermission";
1027
+ PROPERTY_DOCUMENT_COLLAPSE_META: "fileCollapseMetadata";
1028
+ PROPERTY_DOCUMENT_COLLAPSE_FLD_STC: "fileCollapseFldStrc";
1029
+ WRONG_ATT_TYPE_ERROR: "Component does not support attributes of type <TOK>. Contact system administrator";
1030
+ STORE_KEY_FIELD: "field";
1031
+ STORE_KEY_FORM: "form";
1032
+ PROPERTY_ARIA_DESCRIPTION: "ariaDescription";
1033
+ PROPERTY_ARIA_LABEL: "ariaLabel";
1034
+ PROPERTY_ALT: "alt";
1035
+ PROPERTY_AUTO_COMPLETE: "autoComplete";
1036
+ PROPERTY_AUTO_FOCUS: "autoFocus";
1037
+ PROPERTY_INPUT_TYPE: "inputType";
1038
+ PROPERTY_PLACE_HOLDER: "placeHolder";
1039
+ PROPERTY_TITLE: "title";
1040
+ }>> | null | undefined;
1041
+ getFieldColumn(name: string): IApiaField[];
1042
+ getAllFields(): IApiaField[];
1043
+ clearForm(clearReadonlyFields: boolean, deleteGridsRows: boolean): void;
1044
+ hideModal(): void;
1045
+ showAsModal(): void;
797
1046
  }
798
1047
 
799
- type FieldConstructor = new (definition: any) => Field<any, any, any> | FieldWithAttribute<any, any, any> | TranslatableField<any, any, any>;
800
- type FieldsMapping = Record<string, (definition: any) => FieldConstructor>;
1048
+ declare abstract class ApiaField<Props extends typeof FieldConstants = typeof FieldConstants> implements IApiaField<Props> {
1049
+ #private;
1050
+ constructor(execution: Execution, field: Field<any>);
1051
+ get fldType(): "button" | "check" | "file" | "hidden" | "image" | "input" | "href" | "multiple" | "radio" | "select" | "label" | "area" | "title" | "editor" | "grid" | "password" | "captcha" | "tree";
1052
+ get fldId(): string;
1053
+ get form(): ApiaForm;
1054
+ get index(): number;
1055
+ setProperty<K extends keyof Props>(name: Props[K], value: unknown): void;
1056
+ getProperty<K extends keyof Props>(name: Props[K]): unknown;
1057
+ setFocus(): IApiaField | null;
1058
+ isInGrid(): boolean;
1059
+ }
801
1060
 
802
- type NotificationIcon = string;
803
- type NotificationType = 'info' | 'error' | 'success' | 'warning';
804
- type NotificationDefinition = {
805
- icon?: NotificationIcon;
806
- id?: string | number;
807
- isOpen?: boolean;
808
- message: string;
809
- stackTrace?: string;
810
- title?: string;
811
- type?: NotificationType;
812
- };
813
- declare abstract class Notification<State extends NotificationDefinition = NotificationDefinition> {
814
- readonly props: State;
815
- protected state: State;
816
- constructor(props: State);
817
- get icon(): string | undefined;
818
- get id(): string | number | undefined;
819
- get isOpen(): boolean | undefined;
820
- get message(): string;
821
- get stackTrace(): string | undefined;
822
- get title(): string | undefined;
823
- get type(): NotificationType | undefined;
1061
+ interface IButtonField extends IApiaField {
1062
+ fireClickEvent(): void;
1063
+ getValue(): string | null;
1064
+ }
1065
+ declare class ButtonField extends ApiaField implements IButtonField {
1066
+ #private;
1067
+ constructor(execution: Execution, field: Button);
1068
+ fireClickEvent(): void;
1069
+ getValue(): string | null;
1070
+ clearValue(): void;
1071
+ setValue(value: string): void;
824
1072
  }
825
1073
 
826
- declare class Notifications {
827
- execution: Execution;
828
- private emitter;
829
- constructor(execution: Execution);
830
- protected notifications: Notification[];
831
- add(notification: Notification): void;
832
- closeTab(): void;
833
- getAll(): Notification<NotificationDefinition>[];
834
- getById(id: string | number): Notification<NotificationDefinition> | undefined;
835
- kill(): void;
836
- remove(notification: string | number | Notification): void;
837
- on: <K extends "closeTab" | "kill" | "notification">(event: K, cb: Callback<{
838
- closeTab: null;
839
- kill: null;
840
- notification: Notification;
841
- }, K>) => UnSubscriber;
1074
+ declare class ApiaAttribute {
1075
+ #private;
1076
+ constructor(attribute: Attribute);
1077
+ get attLabel(): string;
1078
+ get name(): string;
1079
+ get id(): string;
1080
+ get valueType(): TApiaFieldValueType;
1081
+ }
1082
+ declare class ApiaFieldWithAttribute<T = string | boolean> extends ApiaField {
1083
+ #private;
1084
+ constructor(execution: Execution, field: FieldWithAttribute);
1085
+ get attribute(): ApiaAttribute;
1086
+ clearValue(): void;
1087
+ getValue(): any;
1088
+ setValue(v: T): void;
1089
+ getLabel(): string | null | void;
1090
+ getProperty<K extends keyof TApiaFieldWithAttributeProperties>(name: TApiaFieldWithAttributeProperties[K]): unknown;
842
1091
  }
843
1092
 
844
- type TProcess = {
845
- calendar: {
846
- fixed: boolean;
847
- label: string;
848
- name: string;
849
- options: {
850
- label: string;
851
- value: string;
852
- selected: boolean;
853
- }[];
854
- toolTip: string;
855
- value: string;
856
- viewButton: {
857
- label: string;
858
- toolTip: string;
859
- };
860
- };
861
- comments: {
862
- currentComment: string;
863
- addMarker: boolean;
864
- markAll: boolean;
865
- deleteMarker: boolean;
866
- history: {
867
- comment: string;
868
- marked: boolean;
869
- date: string;
870
- user: string;
871
- }[];
872
- };
873
- identifier: {
874
- body: {
875
- name: string;
876
- required: boolean;
877
- toolTip: string;
878
- type: 'fixed' | 'custom';
879
- value: string;
880
- };
881
- label: string;
882
- prefix: {
883
- label: string;
884
- name: string;
885
- toolTip: string;
886
- type: 'fixed' | 'custom' | 'none';
887
- value: string;
888
- };
889
- required: boolean;
890
- suffix: {
891
- label: string;
892
- name: string;
893
- toolTip: string;
894
- type: 'fixed' | 'custom' | 'none';
895
- value: string;
896
- };
897
- toolTip: string;
898
- value: string;
899
- };
900
- priority: {
901
- disabled: boolean;
902
- isMonitor: boolean;
903
- label: string;
904
- name: string;
905
- options: {
906
- label: string;
907
- value: string;
908
- selected: boolean;
909
- }[];
910
- toolTip: string;
911
- value: string;
912
- };
913
- process: {
914
- label: string;
915
- toolTip: string;
916
- value: string;
917
- };
918
- processAction: {
919
- label: string;
920
- toolTip: string;
921
- value: string;
922
- };
923
- separator: string;
924
- status?: {
925
- label: string;
926
- toolTip: string;
927
- value: string;
928
- };
929
- title: string;
930
- user: {
931
- label: string;
932
- toolTIp: string;
933
- value: string;
934
- };
935
- };
1093
+ declare class EditorField extends ApiaFieldWithAttribute {
1094
+ }
936
1095
 
937
- /**
938
- * El comportamiento de esta función se explica por su
939
- * nombre.
940
- */
941
- declare function returnExactlyTheSame(defaultParameters: Record<string, unknown>): Record<string, unknown>;
942
- declare function isOneClickUploadEnabled(oneClickUploadProp?: boolean): string | boolean;
943
- declare const parseFileDefinition: (execution: Execution, fileDefinition: TFileUploaded | TUploaderFileInfo, isSignRequired: boolean) => TUploaderFileInfo;
944
- type TOnUploadProgress = (progress: number) => void;
945
- declare class UploaderApi extends EventEmitter$1<{
946
- fileUploaded: null;
947
- }> {
948
- execution: Execution;
949
- id: string;
950
- type: 'E' | 'P';
951
- modalConfig: TModalConfig;
952
- maxFiles: number;
953
- modalController: UploaderModalController | null;
954
- allowTranslations: boolean;
955
- langs: Record<number, string> | undefined;
956
- currentConfiguration: TUploaderLoadCurrentFunctionMessages | undefined;
957
- docTypePermittedObjId: string | undefined;
958
- state: UploaderState;
959
- get filesArray(): TUploaderFileInfo[];
960
- constructor(execution: Execution, id: string, type: 'E' | 'P', modalConfig: TModalConfig);
961
- init(): Promise<void>;
962
- onStartUpload(files?: File[]): Promise<void>;
963
- onTranslateUpload(conf: {
964
- langId: number;
965
- translatingFile: TUploaderFileInfo;
966
- }, files?: File[]): Promise<void>;
967
- onVersionUpload(file: TUploaderFileInfo, conf?: {
968
- newFiles?: File[];
969
- langId?: number;
970
- translatingFile?: TUploaderFileInfo;
971
- }): Promise<void>;
972
- autoLock(): Promise<boolean>;
973
- notify(notification: NotificationDefinition): void;
974
- protected getAjaxUrl(): string;
975
- getDocTypes(): TDocType[];
976
- getCurrentDocTypeId(): string;
977
- getCurrentDocType(): TDocType | undefined;
978
- getInProgressFiles(): File[];
979
- getHiddenFiles(): File[];
980
- getExistingFiles(): Record<string, TUploaderFileInfo>;
981
- getProgress(): number;
982
- getHasAllDocTypes(): boolean | undefined;
983
- getDocumentInfo({ docId: apiId, downloadDocId: docId, }: TRequireOnlyOne<{
984
- docId: string;
985
- downloadDocId: string;
986
- }>, newElem?: boolean): Promise<({
987
- canClose: boolean;
988
- type: string;
989
- } & {
990
- function: {
991
- name: string;
992
- } & {
993
- data: {
994
- onClose: string;
995
- general: TApiaDocumentDefinition;
996
- permissions: {
997
- pool: TDocumentPermission | TDocumentPermission[];
998
- user: TDocumentPermission | TDocumentPermission[];
999
- };
1000
- versions: {
1001
- version: TDocumentVersion | TDocumentVersion[];
1002
- };
1003
- };
1004
- currentUsrPems: {
1005
- usrCanModify: boolean;
1006
- };
1007
- metadatas: {
1008
- metadata: TDocumentMetadata | TDocumentMetadata[];
1009
- };
1010
- docDownHistory: {
1011
- docHistory: TDocumentDownloadHistory | TDocumentDownloadHistory[];
1012
- };
1013
- };
1014
- } & ResponseSysMessages) | null>;
1015
- /**
1016
- * This method searches for the provided id in several places:
1017
- *
1018
- * If it's found in the current files, returns it.
1019
- * If not, it searches the provided docId in the translations map of each uploaded file.
1020
- */
1021
- getDocument(docId: string): TUploaderFileInfo | undefined;
1022
- protected updateDocument(docId: string, newValue: TUploaderFileInfo): void;
1023
- protected deleteDocument(docId: string): void;
1024
- clearFile(name: string): void;
1025
- clearFiles(): void;
1026
- clearState(): void;
1027
- checkLockDocument(id: string, shouldNotifyUnlocked?: boolean): Promise<string | boolean>;
1028
- setCurrentDocTypeId(docTypeId: string): void;
1029
- ajaxUploadStart(newFiles?: File[]): Promise<boolean | undefined>;
1030
- reloadMetadata(props?: Partial<{
1031
- docId: string;
1032
- docTypeId: number | string;
1033
- }>, additionalProps?: Record<string, unknown>): Promise<void>;
1034
- saveDroppedFiles(unprocessedFiles: File[], conf?: TSaveDroppedFilesConf): Promise<boolean>;
1035
- checkWebDavLock(docId: string): Promise<unknown>;
1036
- checkSignature(file: TUploaderFileInfo): Promise<TApiaApiAxiosResponse<({
1037
- markedToSign: boolean;
1038
- } & ResponseSysMessages) | null> | null>;
1039
- editDocument(id: string): Promise<void>;
1040
- downloadDocument(id: string, version?: string): Promise<void>;
1041
- ajaxDeleteDocument(id: string, langId?: number): Promise<void>;
1042
- version(file: TUploaderFileInfo, conf?: {
1043
- newFiles?: File[];
1044
- langId?: number;
1045
- translatingFile?: TUploaderFileInfo;
1046
- }): Promise<void>;
1047
- versionFileInfo(file: TUploaderFileInfo): Promise<void>;
1048
- pickFileById(id: string): Promise<void>;
1049
- markFileToSign(id: string, langId?: string): Promise<void>;
1050
- /**
1051
- * Por el momento realiza la descarga de todos los archivos
1052
- * que estén subidos.
1053
- */
1054
- downloadMultipleDocuments(): void;
1055
- confirmDropModal(conf?: {
1056
- langId?: number;
1057
- translatingFile?: TUploaderFileInfo;
1058
- }): Promise<boolean>;
1059
- loadCurrentDocuments(): Promise<void>;
1060
- lockDocument(id: string): Promise<void>;
1061
- protected evaluateDeleteDocumentResult(result: unknown): boolean;
1062
- setTranslationFile(file: TUploaderFileInfo, docId: string, langId: number): void;
1063
- protected getAjaxUploadFileStatusParameters: typeof returnExactlyTheSame;
1064
- protected getAjaxUploadStartParameters: typeof returnExactlyTheSame;
1065
- protected getConfirmDropModalParameters: typeof returnExactlyTheSame;
1066
- protected getCheckLockDocumentParameters: typeof returnExactlyTheSame;
1067
- protected getCheckWebDavLockParameters: typeof returnExactlyTheSame;
1068
- protected getConfirmDropModalPostdata: typeof returnExactlyTheSame;
1069
- protected getConfirmDropModalMetadataString: ({ metadata, }: {
1070
- metadata: TDocumentMetadata[];
1071
- }) => string;
1072
- protected getConfirmDropModalPermissionsString: ({ poolsPermissions, usersPermissions, }: {
1073
- poolsPermissions: IPoolsPermissions[];
1074
- usersPermissions: IUsersPermissions[];
1075
- }) => string;
1076
- protected getConfirmDropModalAdditionalMetadataString: (additionalMetadata: TDocumentMetadata[] | []) => string;
1077
- protected getDeleteDocumentParameters: typeof returnExactlyTheSame;
1078
- protected getClearTempFilesParameters: typeof returnExactlyTheSame;
1079
- protected getDocumentInfoParameters: typeof returnExactlyTheSame;
1080
- protected getDownloadMultipleDocumentsParameters: typeof returnExactlyTheSame;
1081
- protected getEditDocumentParameters: typeof returnExactlyTheSame;
1082
- protected getLockDocumentParameters: typeof returnExactlyTheSame;
1083
- protected getMarkFileToSignParameters: typeof returnExactlyTheSame;
1084
- protected getProcessDroppedFilesParameters: typeof returnExactlyTheSame;
1085
- protected getProcessDroppedFilesPostdata: typeof returnExactlyTheSame;
1086
- protected getReloadMetadataParameters: typeof returnExactlyTheSame;
1087
- protected getSaveDroppedFilesParameters: typeof returnExactlyTheSame;
1088
- protected filterAlreadyUploadedFiles(files: File[], conf?: TSaveDroppedFilesConf): File[];
1089
- protected filterByFilesAmountLimit(files: File[]): File[];
1090
- protected filterAcceptedFiles(files: File[], shouldNotify?: boolean, docTypeId?: string | TDocType): File[];
1091
- protected filterExistingFiles(files: File[], conf?: TSaveDroppedFilesConf): File[];
1092
- protected filterVersioningFiles(files: File[], conf?: {
1093
- langId?: number;
1094
- strictMode?: boolean;
1095
- translatingFile?: TUploaderFileInfo;
1096
- shouldReset?: boolean;
1097
- }): File[];
1098
- parseFileDefinition: (file: TFileUploaded) => TUploaderFileInfo;
1099
- getLoadFileSystemStructureTree: () => Record<string, unknown>;
1096
+ type TOptionsMap$2 = Map<string, PossibleValue>;
1097
+ type TOptionsAsArray = PossibleValue[];
1098
+ declare class SelectField extends ApiaFieldWithAttribute<string | number | (string | number)[]> {
1099
+ #private;
1100
+ constructor(execution: Execution, field: Select);
1101
+ getOptions(asObject: boolean): TOptionsMap$2 | TOptionsAsArray | null;
1102
+ addOption(optionValue: string | number, showValue: string, allowRepeatedValue: boolean): void;
1103
+ setOptions(optionsArray: PossibleValue[]): void;
1104
+ removeOption(optionValue: string | number): void;
1105
+ getSelectedOption(asObject: boolean): TOptionsMap$2 | PossibleValue[] | null;
1106
+ getSelectedText(): string | null;
1107
+ clearOptions(): void;
1100
1108
  }
1101
1109
 
1102
- declare class UploaderModalController {
1103
- api: UploaderApi;
1104
- modalConfig: TModalConfig;
1105
- conf?: {
1106
- langId?: number;
1107
- translatingFile?: TUploaderFileInfo;
1108
- versionFile?: TUploaderFileInfo;
1109
- } | undefined;
1110
- state: UploaderModalState;
1111
- constructor(api: UploaderApi, modalConfig: TModalConfig, conf?: {
1112
- langId?: number;
1113
- translatingFile?: TUploaderFileInfo;
1114
- versionFile?: TUploaderFileInfo;
1115
- } | undefined);
1116
- get allMetadata(): TDocumentMetadata[];
1117
- get allowAllType(): "" | "M" | "R";
1118
- get description(): string;
1119
- get docFolder(): number | undefined;
1120
- get docExpDate(): string | undefined;
1121
- get docTypes(): TDocType[];
1122
- get freeMetadata(): TDocumentMetadata[];
1123
- get exitingFiles(): Record<string, TUploaderFileInfo>;
1124
- get inProgressFiles(): File[];
1125
- get hiddenFiles(): File[];
1126
- get progress(): number;
1127
- get metadata(): TDocumentMetadata[];
1128
- get selectedDocTypeId(): string;
1129
- get selectedDocType(): TDocType | undefined;
1130
- addMetadata(): void;
1131
- addFiles(files: File[]): void;
1132
- addDirectoryFile(file: TApiaDocumentDefinition): void;
1133
- changeDocType(docTypeId: string): Promise<void>;
1134
- clearDirectoryFile(): void;
1135
- clearFile(name: string): void;
1136
- clearFiles(): void;
1137
- clearState(): void;
1138
- onCloseModal(): void;
1139
- confirm(): Promise<boolean>;
1140
- deleteMetadata(indices: number[]): void;
1141
- deletePermission(item: IPoolsPermissions | IUsersPermissions): void;
1142
- protected onChangeExtension(): void;
1143
- openModal(): Promise<void>;
1144
- setDescription(desc: string): void;
1145
- protected resetMetadata(): Promise<void>;
1146
- validate(): boolean;
1110
+ declare class InputField extends ApiaFieldWithAttribute {
1111
+ #private;
1112
+ constructor(execution: Execution, field: Input);
1113
+ getObjectValue(): number | string | boolean | null;
1114
+ setValue(v: string): void;
1147
1115
  }
1148
1116
 
1149
- type TUploadModalOpener = (controller: UploaderModalController) => void;
1150
- type UploaderModalState = {
1151
- fileReqError: boolean;
1152
- metadata: {
1153
- metadataArray: TDocumentMetadata[];
1154
- isFreeMetadata: boolean;
1155
- freeMetadataArray: TDocumentMetadata[];
1156
- };
1157
- fromDirectoryFile: TApiaDocumentDefinition | null;
1158
- docFolder?: number;
1159
- docExpDate?: string;
1160
- description: string;
1161
- isReadonly?: boolean;
1162
- permissions: {
1163
- allowAllType: 'M' | 'R' | '';
1164
- users: IUsersPermissions[];
1165
- pools: IPoolsPermissions[];
1166
- };
1167
- };
1168
- type UploaderState = {
1169
- progress: number;
1170
- allowedTypes: TDocType[];
1171
- selectedDocTypeId: string;
1172
- versioningFile: TUploaderFileInfo | null;
1173
- inProgressFiles: File[];
1174
- hiddenFiles: File[];
1175
- files: Record<string, TUploaderFileInfo>;
1176
- translatedFiles: Map<string, Map<number, TUploaderFileInfo>>;
1177
- hasAllDocTypes?: boolean;
1178
- selectedFiles: string[];
1179
- };
1180
- interface IUsersPermissions {
1181
- userId: string;
1182
- userLogin: string;
1183
- canUpdate: boolean;
1117
+ declare class TreeField extends ApiaFieldWithAttribute<string | number | (string | number)[]> {
1118
+ #private;
1119
+ constructor(execution: Execution, field: Tree);
1120
+ setValue(v: string | number | (string | number)[]): void;
1184
1121
  }
1185
- interface IPoolsPermissions {
1186
- poolId: string;
1187
- poolName: string;
1188
- canUpdate: boolean;
1189
- }
1190
- type TUploaderFileInfo = Omit<TFileUploaded, 'locked' | 'lock' | 'userLocking' | 'lockedBy'> & {
1191
- canEdit?: boolean;
1192
- canRead?: boolean;
1193
- isLocked: boolean;
1194
- isLockedByMe: boolean;
1195
- isVirtual: boolean;
1196
- lockingUser: string;
1197
- };
1198
- type TFileUploaded = {
1199
- canEdit?: boolean;
1200
- canWrite?: boolean;
1201
- canRead?: boolean;
1202
- description?: string;
1203
- docDescription?: string;
1204
- docId: string;
1205
- docLang?: string;
1206
- docLangGroup?: string;
1207
- docName?: string;
1208
- docSize?: string;
1209
- docTypeFreeMetadata?: boolean;
1210
- docTypeId?: string;
1211
- docTypeLabel?: string;
1212
- docTypeTitle: string;
1213
- downloadDocId: string;
1214
- isMarkedToSign: boolean;
1215
- markedToSign: boolean;
1216
- lock?: string | boolean;
1217
- isLocked?: string | boolean;
1218
- lockedBy?: string;
1219
- name?: string;
1220
- onlyInformation: boolean;
1221
- prefix: string;
1222
- preview: string;
1223
- sign?: string | boolean;
1224
- size?: string;
1225
- userLocking: string;
1226
- virtualDoc?: boolean;
1227
- };
1228
- type TAjaxUploadStart = TApiaLoad<TApiaFunction<{
1229
- general: {
1230
- isDocTypeDisabled: boolean;
1231
- useDocTypePermitted: boolean;
1232
- createMode: boolean;
1233
- allowAllTypes: string;
1234
- allDocTypes: boolean;
1235
- };
1236
- docTypes: {
1237
- docType: TDocType | TDocType[];
1238
- };
1239
- metadatas: {
1240
- metadata: TDocumentMetadata | TDocumentMetadata[];
1241
- };
1242
- }, false>>;
1243
- type TDocType = {
1244
- docExts: string;
1245
- maxSize: number;
1246
- id: string;
1247
- title: string;
1248
- free: boolean;
1249
- selected: boolean;
1250
- };
1251
- type TDocumentMetadata = {
1252
- free: string;
1253
- id: string;
1254
- name: string;
1255
- required: 'Y' | 'N';
1256
- title: string;
1257
- type: 'S' | 'N' | 'D';
1258
- value: string;
1259
- errorMessage: string;
1260
- labelErrorMessage: string;
1261
- };
1262
- type TModalConfig = {
1263
- allowDocumentsMonitor: boolean;
1264
- allowPickFromDirectories: boolean;
1265
- collapsePermissions: boolean;
1266
- collapseDirectories: boolean;
1267
- collapseMetadata: boolean;
1268
- defaultDirectory?: number;
1269
- monitorId?: number;
1270
- oneClickUpload: boolean;
1271
- rootFolder?: string;
1272
- showDirectoriesStructure: boolean;
1273
- showExpDate: boolean;
1274
- showPermissions: boolean;
1275
- showMetadata: boolean;
1276
- translationId?: string;
1277
- };
1278
- type TUploaderLoadCurrentFunctionMessages = {
1279
- allowSign: boolean;
1280
- allowLock: boolean;
1281
- allowMultiple: boolean;
1282
- readOnly: boolean;
1283
- };
1284
- type TSaveDroppedFilesConf = {
1285
- langId?: number;
1286
- strictMode?: boolean;
1287
- translatingFile?: TUploaderFileInfo;
1288
- shouldReset?: boolean;
1289
- };
1290
- type TAjaxUploadFileStatus = TApiaLoad<TApiaFunction<{
1291
- message: {
1292
- label: string;
1293
- name: string;
1294
- }[];
1295
- }>>;
1296
- type TProcessDroppedFiles = TApiaLoad<TApiaFunction<{
1297
- principal: {
1298
- docInfo: TDocInfo | TDocInfo[];
1299
- docTypes: {
1300
- 'data-free': boolean;
1301
- docTypeExtensions: string;
1302
- docTypeId: string;
1303
- docTypeMaxSize: number;
1304
- docTypeName: string;
1305
- };
1306
- elemInfo: {
1307
- elemId: string;
1308
- elemType: string;
1309
- };
1310
- };
1311
- }, false>>;
1312
- type TDocInfo = {
1313
- docInfoName: string;
1314
- docInfoSize: string;
1315
- docInfoTmpId: string;
1316
- docInfoType: string;
1317
- };
1318
- type TConfirmDropModal = TApiaLoad<TApiaFunction<{
1319
- general: TFileUploaded | TFileUploaded[];
1320
- fromForm: {
1321
- fromForm: {
1322
- fromForm: boolean;
1323
- }[];
1324
- };
1325
- }, false>>;
1326
- type TApiaDocumentDefinition = {
1327
- docDesc: string;
1328
- docTypeLabel: string;
1329
- docId: string;
1330
- prefix: string;
1331
- docSize: string;
1332
- docDate: string;
1333
- docDwnExternal: string;
1334
- docExpDate: string;
1335
- docFolder: string;
1336
- docFolderPath: string;
1337
- docUsu: string;
1338
- docAllPoolPerm: 'M' | 'R' | '';
1339
- docName: string;
1340
- docTypeId: string;
1341
- locked: boolean;
1342
- downloadDocId: string;
1343
- };
1344
- type TUploaderLoadCurrentFunction = {
1345
- general?: TFileUploaded | TFileUploaded[];
1346
- messages: {
1347
- message: {
1348
- name: keyof TUploaderLoadCurrentFunctionMessages;
1349
- label: boolean;
1350
- } | {
1351
- name: keyof TUploaderLoadCurrentFunctionMessages;
1352
- label: boolean;
1353
- }[];
1354
- };
1355
- };
1356
- type TDocumentInformation = TApiaLoad<TApiaFunction<{
1357
- data: {
1358
- onClose: string;
1359
- general: TApiaDocumentDefinition;
1360
- permissions: {
1361
- pool: TDocumentPermission | TDocumentPermission[];
1362
- user: TDocumentPermission | TDocumentPermission[];
1363
- };
1364
- versions: {
1365
- version: TDocumentVersion | TDocumentVersion[];
1366
- };
1367
- };
1368
- currentUsrPems: {
1369
- usrCanModify: boolean;
1370
- };
1371
- metadatas: {
1372
- metadata: TDocumentMetadata | TDocumentMetadata[];
1373
- };
1374
- docDownHistory: {
1375
- docHistory: TDocumentDownloadHistory | TDocumentDownloadHistory[];
1376
- };
1377
- }, false>>;
1378
- type TDocumentPermission = {
1379
- id: string;
1380
- name: string;
1381
- permType: 'R' | 'M';
1382
- };
1383
- type TDocumentDownloadHistory = {
1384
- hisDwn: string;
1385
- hisUsr: string;
1386
- hisVer: string;
1387
- };
1388
- type TDocumentVersion = {
1389
- verUser: string;
1390
- verNumber: string;
1391
- verDate: string;
1392
- };
1393
- type TRequireOnlyOne<T, Keys extends keyof T = keyof T> = Pick<T, Exclude<keyof T, Keys>> & {
1394
- [K in Keys]-?: Required<Pick<T, K>> & Partial<Record<Exclude<Keys, K>, undefined>>;
1395
- }[Keys];
1396
-
1397
- declare class FormsUploader extends UploaderApi {
1398
- execution: Execution;
1399
- type: 'E' | 'P';
1400
- modalConfig: TModalConfig;
1401
- field: File$1;
1402
- constructor(execution: Execution, type: 'E' | 'P', modalConfig: TModalConfig, field: File$1);
1403
- isEditionMode: boolean | undefined;
1404
- index(): number;
1405
- elemId(): string;
1406
- protected filterByFilesAmountLimit(files: File[]): File[];
1407
- protected getFormParameters(): {
1408
- frmId: string;
1409
- frmParent: TFrmParent;
1410
- attId: string;
1411
- index: number;
1412
- editionMode: boolean | undefined;
1413
- prefix: TFrmParent;
1414
- };
1415
- evaluateDeleteDocumentResult(result: undefined | {
1416
- success: boolean;
1417
- }): boolean;
1418
- getAjaxUrl(): string;
1419
- getAllowedTypesData(): {
1420
- postData: {
1421
- docTypeId: string | undefined;
1422
- forDropElem: boolean;
1423
- };
1424
- queryData: {
1425
- frmId: string;
1426
- frmParent: TFrmParent;
1427
- attId: string;
1428
- index: number;
1429
- editionMode: boolean | undefined;
1430
- prefix: TFrmParent;
1431
- elemType: string;
1432
- fromFormElem: boolean;
1433
- docTypeId: string | undefined;
1434
- frmOut: boolean;
1435
- };
1436
- };
1437
- getAjaxUploadFileStatusParameters: (defaultParameters: Record<string, unknown>) => Record<string, unknown>;
1438
- getAjaxUploadStartParameters: ({ useDocTypePermitted, docTypePermittedObjType, docTypePermittedObjId, ...defaultParameters }: Record<string, unknown>) => Record<string, unknown>;
1439
- getCheckLockDocumentParameters: ({ prefix, ...parameters }: Record<string, unknown>) => {
1440
- frmId: string;
1441
- frmParent: TFrmParent;
1442
- attId: string;
1443
- index: number;
1444
- editionMode: boolean | undefined;
1445
- prefix: TFrmParent;
1446
- };
1447
- getCheckSignatureParameters: (parameters: Record<string, unknown>) => {
1448
- frmId: string;
1449
- frmParent: TFrmParent;
1450
- };
1451
- getClearTempFilesParameters: ({ elemType, ...rest }: Record<string, unknown>) => {
1452
- frmParent: TFrmParent;
1453
- frmId: string;
1454
- attId: string;
1455
- index: number;
1456
- };
1457
- getConfirmDropModalParameters: (defaultParameters: Record<string, unknown>) => Record<string, unknown>;
1458
- getConfirmDropModalPostdata: ({ pe, ...parameters }: Record<string, unknown>) => Record<string, unknown>;
1459
- getDeleteDocumentParameters: ({ prefix, isAjax, ...currentParameters }: Record<string, unknown>) => {
1460
- frmId: string;
1461
- frmParent: TFrmParent;
1462
- attId: string;
1463
- index: number;
1464
- editionMode: boolean | undefined;
1465
- };
1466
- getDocumentInfoParameters: (parameters: Record<string, unknown>) => {
1467
- ajaxUrl: string;
1468
- };
1469
- getEditDocumentParameters: ({ action, docId }: Record<string, unknown>) => {
1470
- docId: unknown;
1471
- ajaxUrl: string;
1472
- frmId: string;
1473
- frmParent: TFrmParent;
1474
- attId: string;
1475
- index: number;
1476
- action: unknown;
1477
- };
1478
- getLoadFilesForFolderParameters: () => Record<string, unknown>;
1479
- getLoadFileSystemStructureTree: () => {
1480
- useDocTypePermitted: boolean;
1481
- docTypeForcedId: string | undefined;
1482
- };
1483
- getLockDocumentParameters: ({ prefix, isAjax, ...currentParameters }: Record<string, unknown>) => {
1484
- frmId: string;
1485
- frmParent: TFrmParent;
1486
- attId: string;
1487
- index: number;
1488
- editionMode: boolean | undefined;
1489
- };
1490
- getMarkFileToSignParameters: ({ docId, prefix, ...defaultParameters }: Record<string, unknown>) => {
1491
- frmId: string;
1492
- frmParent: TFrmParent;
1493
- attId: string;
1494
- index: number;
1495
- editionMode: boolean | undefined;
1496
- prefix: TFrmParent;
1497
- action: string;
1498
- fldId: string;
1499
- };
1500
- getProcessDroppedFilesParameters: (defaultParameters: Record<string, unknown>) => Record<string, unknown>;
1501
- getProcessDroppedFilesPostdata: ({ useDocTypePermitted, docTypePermittedObjId, docTypePermittedObjType, ...parameters }: Record<string, unknown>) => Record<string, unknown>;
1502
- getReloadMetadataParameters: (defaultParameters: Record<string, unknown>) => Record<string, unknown>;
1503
- getSaveDroppedFilesParameters: (defaultParameters: Record<string, unknown>) => Record<string, unknown>;
1504
- downloadDocument(fileId: string): Promise<void>;
1505
- loadCurrentDocuments(): Promise<void>;
1506
- parseFileDefinition: (file: TFileUploaded) => TUploaderFileInfo;
1507
- saveDroppedFiles(unprocessedFiles: File[], conf?: TSaveDroppedFilesConf | undefined): Promise<boolean>;
1508
- }
1509
-
1510
- declare class Process {
1511
- execution: Execution;
1512
- state: TProcess | null;
1513
- uploader: UploaderApi;
1514
- constructor(execution: Execution);
1515
- get name(): string | undefined;
1516
- private hasInited;
1517
- init(): Promise<void>;
1518
- getConfirmParams(): {
1519
- cmbProPri: string | undefined;
1520
- selCal: string | undefined;
1521
- };
1522
- setPriority(newPriority: string): void;
1523
- }
1524
-
1525
- declare class Task {
1526
- #private;
1527
- constructor(task: any);
1528
- setPriority(newPriority: string): void;
1529
- get name(): string;
1530
- }
1531
-
1532
- type TEntity = {
1533
- title: string;
1534
- readOnly: boolean;
1535
- separator: string;
1536
- associations: Associations[];
1537
- date: {
1538
- label: string;
1539
- toolTip: string;
1540
- value: string;
1541
- };
1542
- entityType: {
1543
- label: string;
1544
- toolTip: string;
1545
- value: string;
1546
- };
1547
- identifier: {
1548
- label: string;
1549
- toolTip: string;
1550
- value?: string;
1551
- prefix?: {
1552
- name: string;
1553
- type: 'custom' | 'fixed' | 'none';
1554
- label?: string;
1555
- toolTip?: string;
1556
- value?: string;
1557
- };
1558
- body: {
1559
- type: 'autogenerated' | 'sameAsProcess';
1560
- label: string;
1561
- name?: string;
1562
- toolTip?: string;
1563
- value?: string;
1564
- required?: false;
1565
- } | {
1566
- label: string;
1567
- toolTip?: string;
1568
- value?: string;
1569
- type: 'custom';
1570
- required: boolean;
1571
- name: string;
1572
- };
1573
- suffix?: {
1574
- name: string;
1575
- type: 'custom' | 'fixed' | 'none';
1576
- toolTip?: string;
1577
- label?: string;
1578
- value?: string;
1579
- };
1580
- };
1581
- image: {
1582
- label: string;
1583
- toolTip: string;
1584
- file: File | null;
1585
- };
1586
- status: {
1587
- name: string;
1588
- label: string;
1589
- toolTip: string;
1590
- type: 'fixex' | 'select' | 'none';
1591
- value?: string;
1592
- disabled?: boolean;
1593
- options: {
1594
- label: string;
1595
- value: string;
1596
- selected: boolean;
1597
- }[];
1598
- };
1599
- user: {
1600
- label: string;
1601
- name: string;
1602
- toolTip: string;
1603
- };
1604
- categories: TCategory[] | [];
1605
- visibilities: PoolId[];
1606
- };
1607
- type TCategory = {
1608
- checked: boolean;
1609
- envId: string;
1610
- id: string;
1611
- idFather: string;
1612
- name: string;
1613
- };
1614
- type PoolId = {
1615
- poolId: string;
1616
- poolName: string;
1617
- canUpdate: boolean;
1618
- };
1619
- type Associations = {
1620
- asocName: string;
1621
- asocId: string;
1622
- asocRelName: string;
1623
- };
1624
-
1625
- declare class Entity {
1626
- execution: Execution;
1627
- state: TEntity | null;
1628
- uploader: UploaderApi;
1629
- controller: TableController;
1630
- constructor(execution: Execution);
1631
- get name(): string | undefined;
1632
- private hasInited;
1633
- init(): Promise<void>;
1634
- getConfirmParams(): any;
1635
- loadCategories: () => Promise<void>;
1636
- loadPools: () => Promise<void>;
1637
- loadAssociations: () => Promise<void>;
1638
- private parseRows;
1639
- deleteRow(): void;
1640
- addRow(): void;
1641
- }
1642
-
1643
- type TObservations = {
1644
- observations: TObservation[] | [];
1645
- newObservation: {
1646
- commentValue: string;
1647
- chkAddAlert?: boolean;
1648
- chkAddAllAlert?: boolean;
1649
- chkRemAlert?: boolean;
1650
- } | null;
1651
- };
1652
- type TObservation = {
1653
- name: string;
1654
- date: string;
1655
- userTitle: string;
1656
- groupTitle: string;
1657
- taskTitle: string;
1658
- userLabel: string;
1659
- groupLabel: string;
1660
- taskLabel: string;
1661
- checked?: boolean;
1662
- disabled?: boolean;
1663
- marked?: boolean;
1664
- comment: string;
1665
- };
1666
-
1667
- declare class Observations {
1668
- execution: Execution;
1669
- state: TObservations;
1670
- constructor(execution: Execution);
1671
- private hasInited;
1672
- init(): Promise<void>;
1673
- getConfirmParams(): {
1674
- txtComment: string | undefined;
1675
- chkAddAlert: string | undefined;
1676
- chkAddAllAlert: string | undefined;
1677
- chkRemAlert: string | undefined;
1678
- };
1679
- setPriority(newPriority: string): void;
1122
+
1123
+ declare class CheckField extends ApiaFieldWithAttribute {
1124
+ clearValue(): void;
1125
+ setValue(value: string | boolean | number): void;
1680
1126
  }
1681
1127
 
1682
- type ConfirmStep = 'CHECK_LOCK' | 'CONFIRM' | 'CHECK_SIGN' | 'CHECK_WIZARD' | 'SIGN';
1683
- type Status = {
1684
- step?: ConfirmStep;
1685
- error?: string;
1686
- finishedWithError?: boolean;
1687
- };
1688
- declare abstract class FlowModal<T extends {
1689
- confirmed?: boolean;
1690
- }> {
1691
- abstract confirm(result: T): Promise<Status | FlowModal<any>>;
1128
+ type TOptionsMap$1 = Map<string, PossibleValue>;
1129
+ declare class RadioField extends ApiaFieldWithAttribute {
1130
+ #private;
1131
+ constructor(execution: Execution, field: Radio);
1132
+ getOptions(asObject: boolean): TOptionsMap$1 | PossibleValue[] | null;
1133
+ clearOptions(): void | null;
1134
+ addOption(radioValue: string | number, showValue: string, allowRepeatedValue: boolean): void;
1135
+ setOptions(options: PossibleValue[]): void;
1136
+ removeOption(radioValue: string | number): void;
1137
+ getSelectedOption(asObject: boolean): TOptionsMap$1 | PossibleValue | null;
1138
+ getSelectedText(): string | undefined | null;
1692
1139
  }
1693
1140
 
1694
- declare enum ExecutionState {
1695
- RUNNING = 0,
1696
- LOADING = 1,
1697
- FINISHED = 2,
1698
- RENDERING = 3,
1699
- CONFIRMING = 4,
1700
- FINISHED_WITH_ERROR = 5
1141
+ type TOptionsMap = Map<string, PossibleValue>;
1142
+ declare class MultipleField extends ApiaFieldWithAttribute<string[]> {
1143
+ #private;
1144
+ constructor(execution: Execution, field: Multiple);
1145
+ addOption(optionValue: string | number, showValue: string, allowRepeatedValue: boolean): void;
1146
+ setValue(value: string[]): void;
1147
+ clearOptions(): void;
1148
+ getSelectedOption(asObject: boolean): TOptionsMap | PossibleValue[] | null;
1149
+ getOptions(asObject: boolean): TOptionsMap | PossibleValue[] | null;
1150
+ setOptions(optionsArray: PossibleValue[]): void;
1151
+ removeOption(optionValue: string | number): void;
1701
1152
  }
1702
- type TOnClose = 'clearEvalPath' | 'confirmOkOnClose' | 'confirmOkOnCloseSplash' | 'confirmOkOnSaveSplash' | 'releaseOkOnClose' | null;
1703
- type TErrMessage = {
1704
- message: {
1705
- text: string;
1706
- label?: string;
1707
- };
1708
- };
1709
- type TFetchTaskActionResponse = {
1710
- onClose?: TOnClose;
1711
- sysMessages?: TErrMessage;
1712
- sysExceptions?: TErrMessage;
1713
- type?: string;
1714
- actions?: {
1715
- action: {
1716
- param: string[];
1717
- toDo: string;
1718
- };
1719
- };
1720
- load?: {
1721
- canClose: boolean;
1722
- type: string;
1723
- text: {
1724
- label: string;
1725
- closeAll: boolean;
1726
- addClass?: string;
1727
- title?: string;
1728
- };
1729
- };
1730
- text?: {
1731
- title?: string;
1732
- label?: string;
1733
- };
1734
- };
1735
-
1736
- type TCheckWizardResponse = {
1737
- url: string;
1738
- };
1739
- type TFetchConfirmPathResponse = {
1740
- onClose?: string;
1741
- sysMessages?: {
1742
- message?: {
1743
- text: string;
1744
- };
1745
- };
1746
- pathSelection?: boolean | null;
1747
- groupSelection?: boolean | null;
1748
- load?: TApiaLoadForm & {
1749
- type: 'form' | 'text' | 'table' | 'function';
1750
- canClose: boolean;
1751
- text?: {
1752
- closeAll: string;
1753
- title: string;
1754
- addClass: string;
1755
- label: string;
1756
- content?: string;
1757
- };
1758
- };
1759
- actions?: {
1760
- action: {
1761
- toDo: 'functionTimedCall';
1762
- param: [number, string];
1763
- };
1764
- };
1765
- };
1766
- type TItemTreeObj = {
1767
- id: string;
1768
- name: string;
1769
- level: number;
1770
- value: boolean;
1771
- type: TPathType;
1772
- isOn: boolean;
1773
- };
1774
- type TPathType = 'OR' | 'XOR' | 'AND';
1775
1153
 
1776
- declare class ShowPathSelection extends FlowModal<{
1777
- confirmed: boolean;
1778
- path: string;
1779
- }> {
1780
- fetchResult: TApiaLoadForm['form'];
1781
- confirm: (result: {
1782
- confirmed: boolean;
1783
- path: string;
1784
- }) => Promise<Status | FlowModal<any>>;
1785
- state: {
1786
- disabledParents: TItemTreeObj | TItemTreeObj[] | null;
1787
- groupSelectionObj: TFetchConfirmPathResponse | null;
1788
- };
1789
- constructor(fetchResult: TApiaLoadForm['form'], confirm: (result: {
1790
- confirmed: boolean;
1791
- path: string;
1792
- }) => Promise<Status | FlowModal<any>>);
1793
- setDisabledParent(treeItem: TItemTreeObj): void;
1794
- clearPaths(): void;
1795
- showGroupsSelection(fetchConfirmPathResponse: TFetchConfirmPathResponse): void;
1796
- updateDisabledList(itemObj: TItemTreeObj, itemArr: TItemTreeObj[]): TItemTreeObj[];
1154
+ declare class HiddenField extends ApiaField {
1797
1155
  }
1798
1156
 
1799
- declare class ShowPoolSelection extends FlowModal<{
1800
- confirmed: boolean;
1801
- group: string;
1802
- }> {
1803
- fetchResult: TApiaLoadForm['form'];
1804
- confirm: (result: {
1805
- confirmed: boolean;
1806
- group: string;
1807
- }) => Promise<Status>;
1808
- constructor(fetchResult: TApiaLoadForm['form'], confirm: (result: {
1809
- confirmed: boolean;
1810
- group: string;
1811
- }) => Promise<Status>);
1157
+ declare class AreaField extends ApiaFieldWithAttribute {
1812
1158
  }
1813
1159
 
1814
- declare class ShowSignSelection extends FlowModal<{
1815
- confirmed: boolean;
1816
- signed: boolean;
1817
- }> {
1818
- fetchResult: any;
1819
- confirm: (result: {
1820
- confirmed: boolean;
1821
- signed: boolean;
1822
- }) => Promise<Status>;
1823
- constructor(fetchResult: any, confirm: (result: {
1824
- confirmed: boolean;
1825
- signed: boolean;
1826
- }) => Promise<Status>);
1160
+ interface IImageField extends IApiaField {
1161
+ getValue(): null;
1162
+ setValue(): null;
1163
+ getLabel(): void;
1164
+ clearValue(): null;
1165
+ }
1166
+ declare class ImageField extends ApiaField implements IImageField {
1167
+ #private;
1168
+ constructor(execution: Execution, field: Image);
1169
+ clearValue(): null;
1170
+ getLabel(): void;
1171
+ getValue(): null;
1172
+ setValue(): null;
1827
1173
  }
1828
1174
 
1829
- declare class ShowConfirmMessage extends FlowModal<{
1830
- confirmed: boolean;
1831
- }> {
1832
- fetchResult: any;
1833
- confirm: (result: {
1834
- confirmed: boolean;
1835
- }) => Promise<Status>;
1836
- constructor(fetchResult: any, confirm: (result: {
1837
- confirmed: boolean;
1838
- }) => Promise<Status>);
1175
+ interface ILinkField extends IApiaField {
1176
+ getLabel(): void;
1177
+ }
1178
+ declare class LinkField extends ApiaField implements ILinkField {
1179
+ #private;
1180
+ constructor(execution: Execution, field: Link);
1181
+ getLabel(): void;
1839
1182
  }
1840
1183
 
1841
- declare class ShowSign extends FlowModal<{
1842
- confirmed: boolean;
1843
- }> {
1844
- fetchResult: any;
1845
- confirm: (result: {
1846
- confirmed: boolean;
1847
- }) => Promise<Status>;
1848
- constructor(fetchResult: any, confirm: (result: {
1849
- confirmed: boolean;
1850
- }) => Promise<Status>);
1184
+ interface ITextField extends IApiaField {
1185
+ getLabel(): void;
1186
+ }
1187
+ declare class TextField extends ApiaField implements ITextField {
1188
+ #private;
1189
+ constructor(execution: Execution, field: Field);
1190
+ getLabel(): void;
1191
+ setValue(value: string): void;
1851
1192
  }
1852
1193
 
1853
- type TExecutionConfig = {
1854
- canConfirm: boolean;
1855
- canGoBack: boolean;
1856
- canGoForward: boolean;
1857
- canSave: boolean;
1858
- canFree: boolean;
1859
- canDelegate: boolean;
1860
- canClose: boolean;
1861
- canShare: boolean;
1862
- isEntity?: boolean;
1863
- };
1864
- type TExecutionEnvironment = {
1865
- fieldsMapping?: FieldsMapping;
1866
- window: Window;
1867
- document: Document;
1868
- headers: any;
1869
- properties?: {
1870
- taskName: string;
1871
- processName: string;
1872
- };
1873
- };
1874
- declare class Execution extends EventEmitter$1<{
1875
- confirm: null;
1876
- next: null;
1877
- sendToDesktop: null;
1878
- }> {
1879
- environment: TExecutionEnvironment;
1880
- fieldsMapping: FieldsMapping;
1881
- private entity;
1882
- private process;
1883
- private observations;
1884
- executionConfig: TExecutionConfig | null;
1885
- private _steps;
1886
- private _currentStep;
1887
- private _stepCount;
1888
- readonly notifications: Notifications;
1889
- private lastModalReturn;
1890
- constructor(environment: TExecutionEnvironment);
1891
- protected formsById: {
1892
- E: Map<string, Form>;
1893
- P: Map<string, Form>;
1894
- };
1895
- protected forms: {
1896
- E: Map<string, Form>;
1897
- P: Map<string, Form>;
1898
- };
1899
- state: {
1900
- executionState: ExecutionState;
1901
- locked: boolean;
1902
- hasChangedAnything: boolean;
1903
- };
1904
- getAllForms(): Form[];
1905
- private hasInitializedFormsTabs;
1906
- initializeFormsTabs(frmParent: TFrmParent, cb: () => unknown): void;
1907
- getFormsByType(type: TFrmParent): Form[];
1908
- getFormByName(formName: string, frmParent?: TFrmParent): Form | undefined;
1909
- getFormById(formId: string | number, frmParent?: TFrmParent): Form | undefined;
1910
- get currentStep(): number;
1911
- get steps(): {
1912
- title: string;
1913
- stepNumber: number;
1914
- status: "completed" | "pending" | "current";
1915
- }[];
1916
- getEntity(): Entity;
1917
- getProcess(): Process;
1918
- getObservations(): Observations;
1919
- getCurrentTask(): Task;
1920
- private mustRenderForms;
1921
- run(executionConfig: TExecutionConfig): Promise<void>;
1922
- protected getHiddenForms(): Form[];
1923
- markFormAsRendered(frmParent: string, frmName: string): void;
1924
- delegate(): Promise<void>;
1925
- shareSocial(): Promise<void>;
1926
- confirm(): void;
1927
- next(): void;
1928
- sendToDesktop(): void;
1929
- doBack(): Promise<false | undefined>;
1930
- doConfirm(status?: Status): Promise<boolean | FlowModal<any> | Field>;
1931
- doFree(): Promise<TApiaApiAxiosResponse<(TFetchTaskActionResponse & ResponseSysMessages) | null> | null>;
1932
- doNext(result?: {
1933
- confirmed: boolean;
1934
- signed: boolean;
1935
- }): Promise<boolean | Field<TApiaFieldCommonProperties, TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, {
1936
- definition: Omit<TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, "properties">;
1937
- }> | ShowSignSelection | undefined>;
1938
- doPrint(): Promise<void>;
1939
- doSave(): Promise<TApiaApiAxiosResponse<(TFetchTaskActionResponse & ResponseSysMessages) | null> | undefined>;
1940
- getStepTitle(step: number): {
1941
- title: string;
1942
- stepNumber: number;
1943
- status: "completed" | "pending" | "current";
1944
- } | undefined;
1945
- /**
1946
- * Ends the current session
1947
- */
1948
- kill(): void;
1949
- viewDocs(): Promise<(Record<string, unknown> & ResponseSysMessages) | undefined>;
1950
- setStepTitle(stepNumber: number, stepTitle: string): void;
1951
- validate(): Promise<true | Field>;
1952
- setLastModalReturn(value: string[]): void;
1953
- getLastModalReturn(): string[];
1954
- private fireEvents;
1194
+ declare class GridField extends ApiaField {
1195
+ #private;
1196
+ constructor(execution: Execution, field: Grid);
1197
+ addRow(): Promise<IApiaField[]>;
1198
+ clearGrid(): void;
1199
+ clearPage(): void;
1200
+ clearRow(index: number): Promise<void>;
1201
+ closeForm(): GridField;
1202
+ deleteAllRows(): Promise<void>;
1203
+ deleteGrid(): Promise<void>;
1204
+ deletePage(): void;
1205
+ deleteRow(index: number): Promise<void>;
1206
+ editRow(index: number): void;
1207
+ getAllColumns(): (IApiaField<Readonly<{
1208
+ TYPE_INPUT: "input";
1209
+ TYPE_SELECT: "select";
1210
+ TYPE_RADIO: "radio";
1211
+ TYPE_CHECK: "check";
1212
+ TYPE_BUTTON: "button";
1213
+ TYPE_AREA: "area";
1214
+ TYPE_LABEL: "label";
1215
+ TYPE_TITLE: "title";
1216
+ TYPE_FILE: "file";
1217
+ TYPE_MULTIPLE: "multiple";
1218
+ TYPE_HIDDEN: "hidden";
1219
+ TYPE_PASSWORD: "password";
1220
+ TYPE_GRID: "grid";
1221
+ TYPE_IMAGE: "image";
1222
+ TYPE_HREF: "href";
1223
+ TYPE_EDITOR: "editor";
1224
+ TYPE_TREE: "tree";
1225
+ TYPE_CAPTCHA: "captcha";
1226
+ PROPERTY_NAME: "name";
1227
+ PROPERTY_SIZE: "size";
1228
+ PROPERTY_READONLY: "readonly";
1229
+ PROPERTY_DISABLED: "disabled";
1230
+ PROPERTY_MODAL_DISABLED: "modalDisabled";
1231
+ PROPERTY_FONT_COLOR: "fontColor";
1232
+ PROPERTY_VALUE: "value";
1233
+ PROPERTY_REQUIRED: "required";
1234
+ PROPERTY_COLSPAN: "colspan";
1235
+ PROPERTY_ROWSPAN: "rowspan";
1236
+ PROPERTY_MODAL: "modal";
1237
+ PROPERTY_ROWS: "thisRows";
1238
+ PROPERTY_BOLD: "bold";
1239
+ PROPERTY_UNDERLINED: "underlined";
1240
+ PROPERTY_ALIGNMENT: "alignment";
1241
+ PROPERTY_IMAGE: "imageUrl";
1242
+ PROPERTY_COL_WIDTH: "colWidth";
1243
+ PROPERTY_GRID_HEIGHT: "gridHeight";
1244
+ PROPERTY_HIDE_GRID_BTN: "hideGridButtons";
1245
+ PROPERTY_VISIBILITY_HIDDEN: "visibilityHidden";
1246
+ PROPERTY_TRANSIENT: "transient";
1247
+ PROPERTY_GRID_TITLE: "gridTitle";
1248
+ PROPERTY_GRID_FORM: "gridForm";
1249
+ PROPERTY_TOOLTIP: "tooltip";
1250
+ PROPERTY_VALUE_COLOR: "valueColor";
1251
+ PROPERTY_INPUT_AS_TEXT: "inputAsText";
1252
+ PROPERTY_NO_DOWNLOAD: "noDownload";
1253
+ PROPERTY_NO_ERASE: "noErase";
1254
+ PROPERTY_NO_LOCK: "noLock";
1255
+ PROPERTY_NO_HISTORY: "noHistory";
1256
+ PROPERTY_NO_MODIFY: "noModify";
1257
+ PROPERTY_ALLOW_EDITION: "allowEdition";
1258
+ PROPERTY_HIDE_SIGN_ICONS: "hideSignButtons";
1259
+ PROPERTY_URL: "url";
1260
+ PROPERTY_GRID_HIDE_BTN_ORDER: "hideOrderButton";
1261
+ PROPERTY_GRID_HIDE_BTN_INCLUDE: "hideIncludeButton";
1262
+ PROPERTY_REGEXP_MESSAGE: "regExpMessage";
1263
+ PROPERTY_PAGED_GRID: "paged";
1264
+ PROPERTY_PAGED_GRID_SIZE: "pagedGridSize";
1265
+ PROPERTY_GRID_ALTER_IN_LAST_PAGE: "alterOnlyLastPage";
1266
+ PROPERTY_GRID_PRINT_HORIZONTAL: "printHorizontal";
1267
+ PROPERTY_STORE_MODAL_QUERY_RESULT: "storeMdlQryResult";
1268
+ PROPERTY_INCLUDE_FIRST_ROW: "includeFirstRow";
1269
+ PROPERTY_MAX_REG_GRID: "maxRecords";
1270
+ PROPERTY_GRID_LABEL: "gridColTitle";
1271
+ PROPERTY_GRID_QUERY: "gridQuery";
1272
+ PROPERTY_HIDE_DOC_PERMISSIONS: "hideDocPermissions";
1273
+ PROPERTY_VERIFY_SIGNATURE_ONLY: "verifySignatureOnly";
1274
+ PROPERTY_GRID_HIDE_BTN_ADD: "hideAddButton";
1275
+ PROPERTY_GRID_HIDE_BTN_DEL: "hideDelButton";
1276
+ PROPERTY_HIDE_DOC_UPLOAD: "hideDocUpload";
1277
+ PROPERTY_HIDE_DOC_DOWNLOAD: "hideDocDownload";
1278
+ PROPERTY_HIDE_DOC_ERASE: "hideDocErase";
1279
+ PROPERTY_HIDE_DOC_LOCK: "hideDocLock";
1280
+ PROPERTY_HIDE_DOC_HISTORY: "hideDocHistory";
1281
+ PROPERTY_HIDE_DOC_SIGN: "hideSignButtons";
1282
+ PROPERTY_DISPLAY_NONE: "displayNone";
1283
+ PROPERTY_DONT_BREAK_RADIO: "dontBreakRadio";
1284
+ PROPERTY_CHECKED: "checked";
1285
+ PROPERTY_FILE_PREVIEW: "filePreview";
1286
+ PROPERTY_NOT_PRINT: "noPrint";
1287
+ PROPERTY_SELECT_PARENT: "selParent";
1288
+ PROPERTY_HEIGHT: "height";
1289
+ PROPERTY_MULTISELECT: "multiselect";
1290
+ PROPERTY_SEL_PARENT: "selParent";
1291
+ PROPERTY_PARENT_ICON: "parentIcon";
1292
+ PROPERTY_LEAF_ICON: "leafIcon";
1293
+ PROPERTY_CSS_CLASS: "cssClass";
1294
+ PROPERTY_DOC_TYPE: "docType";
1295
+ PROPERTY_HIDE_DOC_METADATA: "hideDocMetadata";
1296
+ PROPERTY_TRANSLATION_REQUIRED: "reqTrad";
1297
+ PROPERTY_SIGNATURE_REQUIRED: "reqSign";
1298
+ PROPERTY_SHOW_TOOLTIP_AS_HELP: "tooltipHelp";
1299
+ PROPERTY_DOCUMENT_MONITOR_DEF: "documentMonitorDef";
1300
+ PROPERTY_DOCUMENT_MONITOR_CUS: "documentMonitorCus";
1301
+ PROPERTY_DOCUMENT_SHOW_FOLD_TREE_BTN: "fileShwFoldTreeBtn";
1302
+ PROPERTY_DOCUMENT_SHOW_FOLD_TREE_STR: "fileShwFoldTreeStr";
1303
+ PROPERTY_DOCUMENT_NO_ALLOW_DRAG_DROP: "fileNoAllwDnD";
1304
+ PROPERTY_DOCUMENT_NO_SHOW_MODAL: "fileDntShwDocMdlOnDrop";
1305
+ PROPERTY_DOCUMENT_SHOW_DESC: "fileShowDesc";
1306
+ PROPERTY_DOCUMENT_DEFAULT_FOLDER: "fileDefFolder";
1307
+ PROPERTY_DOCUMENT_ROOT_FOLDER: "fileRootFolder";
1308
+ PROPERTY_DOCUMENT_EXP_DATE: "fileExpDate";
1309
+ PROPERTY_DOCUMENT_DNT_SHW_DOC_MON: "fileNotShowDocMon";
1310
+ PROPERTY_DOCUMENT_COLLAPSE_PERM: "fileCollapsePermission";
1311
+ PROPERTY_DOCUMENT_COLLAPSE_META: "fileCollapseMetadata";
1312
+ PROPERTY_DOCUMENT_COLLAPSE_FLD_STC: "fileCollapseFldStrc";
1313
+ WRONG_ATT_TYPE_ERROR: "Component does not support attributes of type <TOK>. Contact system administrator";
1314
+ STORE_KEY_FIELD: "field";
1315
+ STORE_KEY_FORM: "form";
1316
+ PROPERTY_ARIA_DESCRIPTION: "ariaDescription";
1317
+ PROPERTY_ARIA_LABEL: "ariaLabel";
1318
+ PROPERTY_ALT: "alt";
1319
+ PROPERTY_AUTO_COMPLETE: "autoComplete";
1320
+ PROPERTY_AUTO_FOCUS: "autoFocus";
1321
+ PROPERTY_INPUT_TYPE: "inputType";
1322
+ PROPERTY_PLACE_HOLDER: "placeHolder";
1323
+ PROPERTY_TITLE: "title";
1324
+ }>> | null)[][];
1325
+ getColumn(fieldName: string): (IApiaField<Readonly<{
1326
+ TYPE_INPUT: "input";
1327
+ TYPE_SELECT: "select";
1328
+ TYPE_RADIO: "radio";
1329
+ TYPE_CHECK: "check";
1330
+ TYPE_BUTTON: "button";
1331
+ TYPE_AREA: "area";
1332
+ TYPE_LABEL: "label";
1333
+ TYPE_TITLE: "title";
1334
+ TYPE_FILE: "file";
1335
+ TYPE_MULTIPLE: "multiple";
1336
+ TYPE_HIDDEN: "hidden";
1337
+ TYPE_PASSWORD: "password";
1338
+ TYPE_GRID: "grid";
1339
+ TYPE_IMAGE: "image";
1340
+ TYPE_HREF: "href";
1341
+ TYPE_EDITOR: "editor";
1342
+ TYPE_TREE: "tree";
1343
+ TYPE_CAPTCHA: "captcha";
1344
+ PROPERTY_NAME: "name";
1345
+ PROPERTY_SIZE: "size";
1346
+ PROPERTY_READONLY: "readonly";
1347
+ PROPERTY_DISABLED: "disabled";
1348
+ PROPERTY_MODAL_DISABLED: "modalDisabled";
1349
+ PROPERTY_FONT_COLOR: "fontColor";
1350
+ PROPERTY_VALUE: "value";
1351
+ PROPERTY_REQUIRED: "required";
1352
+ PROPERTY_COLSPAN: "colspan";
1353
+ PROPERTY_ROWSPAN: "rowspan";
1354
+ PROPERTY_MODAL: "modal";
1355
+ PROPERTY_ROWS: "thisRows";
1356
+ PROPERTY_BOLD: "bold";
1357
+ PROPERTY_UNDERLINED: "underlined";
1358
+ PROPERTY_ALIGNMENT: "alignment";
1359
+ PROPERTY_IMAGE: "imageUrl";
1360
+ PROPERTY_COL_WIDTH: "colWidth";
1361
+ PROPERTY_GRID_HEIGHT: "gridHeight";
1362
+ PROPERTY_HIDE_GRID_BTN: "hideGridButtons";
1363
+ PROPERTY_VISIBILITY_HIDDEN: "visibilityHidden";
1364
+ PROPERTY_TRANSIENT: "transient";
1365
+ PROPERTY_GRID_TITLE: "gridTitle";
1366
+ PROPERTY_GRID_FORM: "gridForm";
1367
+ PROPERTY_TOOLTIP: "tooltip";
1368
+ PROPERTY_VALUE_COLOR: "valueColor";
1369
+ PROPERTY_INPUT_AS_TEXT: "inputAsText";
1370
+ PROPERTY_NO_DOWNLOAD: "noDownload";
1371
+ PROPERTY_NO_ERASE: "noErase";
1372
+ PROPERTY_NO_LOCK: "noLock";
1373
+ PROPERTY_NO_HISTORY: "noHistory";
1374
+ PROPERTY_NO_MODIFY: "noModify";
1375
+ PROPERTY_ALLOW_EDITION: "allowEdition";
1376
+ PROPERTY_HIDE_SIGN_ICONS: "hideSignButtons";
1377
+ PROPERTY_URL: "url";
1378
+ PROPERTY_GRID_HIDE_BTN_ORDER: "hideOrderButton";
1379
+ PROPERTY_GRID_HIDE_BTN_INCLUDE: "hideIncludeButton";
1380
+ PROPERTY_REGEXP_MESSAGE: "regExpMessage";
1381
+ PROPERTY_PAGED_GRID: "paged";
1382
+ PROPERTY_PAGED_GRID_SIZE: "pagedGridSize";
1383
+ PROPERTY_GRID_ALTER_IN_LAST_PAGE: "alterOnlyLastPage";
1384
+ PROPERTY_GRID_PRINT_HORIZONTAL: "printHorizontal";
1385
+ PROPERTY_STORE_MODAL_QUERY_RESULT: "storeMdlQryResult";
1386
+ PROPERTY_INCLUDE_FIRST_ROW: "includeFirstRow";
1387
+ PROPERTY_MAX_REG_GRID: "maxRecords";
1388
+ PROPERTY_GRID_LABEL: "gridColTitle";
1389
+ PROPERTY_GRID_QUERY: "gridQuery";
1390
+ PROPERTY_HIDE_DOC_PERMISSIONS: "hideDocPermissions";
1391
+ PROPERTY_VERIFY_SIGNATURE_ONLY: "verifySignatureOnly";
1392
+ PROPERTY_GRID_HIDE_BTN_ADD: "hideAddButton";
1393
+ PROPERTY_GRID_HIDE_BTN_DEL: "hideDelButton";
1394
+ PROPERTY_HIDE_DOC_UPLOAD: "hideDocUpload";
1395
+ PROPERTY_HIDE_DOC_DOWNLOAD: "hideDocDownload";
1396
+ PROPERTY_HIDE_DOC_ERASE: "hideDocErase";
1397
+ PROPERTY_HIDE_DOC_LOCK: "hideDocLock";
1398
+ PROPERTY_HIDE_DOC_HISTORY: "hideDocHistory";
1399
+ PROPERTY_HIDE_DOC_SIGN: "hideSignButtons";
1400
+ PROPERTY_DISPLAY_NONE: "displayNone";
1401
+ PROPERTY_DONT_BREAK_RADIO: "dontBreakRadio";
1402
+ PROPERTY_CHECKED: "checked";
1403
+ PROPERTY_FILE_PREVIEW: "filePreview";
1404
+ PROPERTY_NOT_PRINT: "noPrint";
1405
+ PROPERTY_SELECT_PARENT: "selParent";
1406
+ PROPERTY_HEIGHT: "height";
1407
+ PROPERTY_MULTISELECT: "multiselect";
1408
+ PROPERTY_SEL_PARENT: "selParent";
1409
+ PROPERTY_PARENT_ICON: "parentIcon";
1410
+ PROPERTY_LEAF_ICON: "leafIcon";
1411
+ PROPERTY_CSS_CLASS: "cssClass";
1412
+ PROPERTY_DOC_TYPE: "docType";
1413
+ PROPERTY_HIDE_DOC_METADATA: "hideDocMetadata";
1414
+ PROPERTY_TRANSLATION_REQUIRED: "reqTrad";
1415
+ PROPERTY_SIGNATURE_REQUIRED: "reqSign";
1416
+ PROPERTY_SHOW_TOOLTIP_AS_HELP: "tooltipHelp";
1417
+ PROPERTY_DOCUMENT_MONITOR_DEF: "documentMonitorDef";
1418
+ PROPERTY_DOCUMENT_MONITOR_CUS: "documentMonitorCus";
1419
+ PROPERTY_DOCUMENT_SHOW_FOLD_TREE_BTN: "fileShwFoldTreeBtn";
1420
+ PROPERTY_DOCUMENT_SHOW_FOLD_TREE_STR: "fileShwFoldTreeStr";
1421
+ PROPERTY_DOCUMENT_NO_ALLOW_DRAG_DROP: "fileNoAllwDnD";
1422
+ PROPERTY_DOCUMENT_NO_SHOW_MODAL: "fileDntShwDocMdlOnDrop";
1423
+ PROPERTY_DOCUMENT_SHOW_DESC: "fileShowDesc";
1424
+ PROPERTY_DOCUMENT_DEFAULT_FOLDER: "fileDefFolder";
1425
+ PROPERTY_DOCUMENT_ROOT_FOLDER: "fileRootFolder";
1426
+ PROPERTY_DOCUMENT_EXP_DATE: "fileExpDate";
1427
+ PROPERTY_DOCUMENT_DNT_SHW_DOC_MON: "fileNotShowDocMon";
1428
+ PROPERTY_DOCUMENT_COLLAPSE_PERM: "fileCollapsePermission";
1429
+ PROPERTY_DOCUMENT_COLLAPSE_META: "fileCollapseMetadata";
1430
+ PROPERTY_DOCUMENT_COLLAPSE_FLD_STC: "fileCollapseFldStrc";
1431
+ WRONG_ATT_TYPE_ERROR: "Component does not support attributes of type <TOK>. Contact system administrator";
1432
+ STORE_KEY_FIELD: "field";
1433
+ STORE_KEY_FORM: "form";
1434
+ PROPERTY_ARIA_DESCRIPTION: "ariaDescription";
1435
+ PROPERTY_ARIA_LABEL: "ariaLabel";
1436
+ PROPERTY_ALT: "alt";
1437
+ PROPERTY_AUTO_COMPLETE: "autoComplete";
1438
+ PROPERTY_AUTO_FOCUS: "autoFocus";
1439
+ PROPERTY_INPUT_TYPE: "inputType";
1440
+ PROPERTY_PLACE_HOLDER: "placeHolder";
1441
+ PROPERTY_TITLE: "title";
1442
+ }>> | null)[];
1443
+ getCurrentPage(): number;
1444
+ getField(fieldName: string, fieldIndex?: number): IApiaField<Readonly<{
1445
+ TYPE_INPUT: "input";
1446
+ TYPE_SELECT: "select";
1447
+ TYPE_RADIO: "radio";
1448
+ TYPE_CHECK: "check";
1449
+ TYPE_BUTTON: "button";
1450
+ TYPE_AREA: "area";
1451
+ TYPE_LABEL: "label";
1452
+ TYPE_TITLE: "title";
1453
+ TYPE_FILE: "file";
1454
+ TYPE_MULTIPLE: "multiple";
1455
+ TYPE_HIDDEN: "hidden";
1456
+ TYPE_PASSWORD: "password";
1457
+ TYPE_GRID: "grid";
1458
+ TYPE_IMAGE: "image";
1459
+ TYPE_HREF: "href";
1460
+ TYPE_EDITOR: "editor";
1461
+ TYPE_TREE: "tree";
1462
+ TYPE_CAPTCHA: "captcha";
1463
+ PROPERTY_NAME: "name";
1464
+ PROPERTY_SIZE: "size";
1465
+ PROPERTY_READONLY: "readonly";
1466
+ PROPERTY_DISABLED: "disabled";
1467
+ PROPERTY_MODAL_DISABLED: "modalDisabled";
1468
+ PROPERTY_FONT_COLOR: "fontColor";
1469
+ PROPERTY_VALUE: "value";
1470
+ PROPERTY_REQUIRED: "required";
1471
+ PROPERTY_COLSPAN: "colspan";
1472
+ PROPERTY_ROWSPAN: "rowspan";
1473
+ PROPERTY_MODAL: "modal";
1474
+ PROPERTY_ROWS: "thisRows";
1475
+ PROPERTY_BOLD: "bold";
1476
+ PROPERTY_UNDERLINED: "underlined";
1477
+ PROPERTY_ALIGNMENT: "alignment";
1478
+ PROPERTY_IMAGE: "imageUrl";
1479
+ PROPERTY_COL_WIDTH: "colWidth";
1480
+ PROPERTY_GRID_HEIGHT: "gridHeight";
1481
+ PROPERTY_HIDE_GRID_BTN: "hideGridButtons";
1482
+ PROPERTY_VISIBILITY_HIDDEN: "visibilityHidden";
1483
+ PROPERTY_TRANSIENT: "transient";
1484
+ PROPERTY_GRID_TITLE: "gridTitle";
1485
+ PROPERTY_GRID_FORM: "gridForm";
1486
+ PROPERTY_TOOLTIP: "tooltip";
1487
+ PROPERTY_VALUE_COLOR: "valueColor";
1488
+ PROPERTY_INPUT_AS_TEXT: "inputAsText";
1489
+ PROPERTY_NO_DOWNLOAD: "noDownload";
1490
+ PROPERTY_NO_ERASE: "noErase";
1491
+ PROPERTY_NO_LOCK: "noLock";
1492
+ PROPERTY_NO_HISTORY: "noHistory";
1493
+ PROPERTY_NO_MODIFY: "noModify";
1494
+ PROPERTY_ALLOW_EDITION: "allowEdition";
1495
+ PROPERTY_HIDE_SIGN_ICONS: "hideSignButtons";
1496
+ PROPERTY_URL: "url";
1497
+ PROPERTY_GRID_HIDE_BTN_ORDER: "hideOrderButton";
1498
+ PROPERTY_GRID_HIDE_BTN_INCLUDE: "hideIncludeButton";
1499
+ PROPERTY_REGEXP_MESSAGE: "regExpMessage";
1500
+ PROPERTY_PAGED_GRID: "paged";
1501
+ PROPERTY_PAGED_GRID_SIZE: "pagedGridSize";
1502
+ PROPERTY_GRID_ALTER_IN_LAST_PAGE: "alterOnlyLastPage";
1503
+ PROPERTY_GRID_PRINT_HORIZONTAL: "printHorizontal";
1504
+ PROPERTY_STORE_MODAL_QUERY_RESULT: "storeMdlQryResult";
1505
+ PROPERTY_INCLUDE_FIRST_ROW: "includeFirstRow";
1506
+ PROPERTY_MAX_REG_GRID: "maxRecords";
1507
+ PROPERTY_GRID_LABEL: "gridColTitle";
1508
+ PROPERTY_GRID_QUERY: "gridQuery";
1509
+ PROPERTY_HIDE_DOC_PERMISSIONS: "hideDocPermissions";
1510
+ PROPERTY_VERIFY_SIGNATURE_ONLY: "verifySignatureOnly";
1511
+ PROPERTY_GRID_HIDE_BTN_ADD: "hideAddButton";
1512
+ PROPERTY_GRID_HIDE_BTN_DEL: "hideDelButton";
1513
+ PROPERTY_HIDE_DOC_UPLOAD: "hideDocUpload";
1514
+ PROPERTY_HIDE_DOC_DOWNLOAD: "hideDocDownload";
1515
+ PROPERTY_HIDE_DOC_ERASE: "hideDocErase";
1516
+ PROPERTY_HIDE_DOC_LOCK: "hideDocLock";
1517
+ PROPERTY_HIDE_DOC_HISTORY: "hideDocHistory";
1518
+ PROPERTY_HIDE_DOC_SIGN: "hideSignButtons";
1519
+ PROPERTY_DISPLAY_NONE: "displayNone";
1520
+ PROPERTY_DONT_BREAK_RADIO: "dontBreakRadio";
1521
+ PROPERTY_CHECKED: "checked";
1522
+ PROPERTY_FILE_PREVIEW: "filePreview";
1523
+ PROPERTY_NOT_PRINT: "noPrint";
1524
+ PROPERTY_SELECT_PARENT: "selParent";
1525
+ PROPERTY_HEIGHT: "height";
1526
+ PROPERTY_MULTISELECT: "multiselect";
1527
+ PROPERTY_SEL_PARENT: "selParent";
1528
+ PROPERTY_PARENT_ICON: "parentIcon";
1529
+ PROPERTY_LEAF_ICON: "leafIcon";
1530
+ PROPERTY_CSS_CLASS: "cssClass";
1531
+ PROPERTY_DOC_TYPE: "docType";
1532
+ PROPERTY_HIDE_DOC_METADATA: "hideDocMetadata";
1533
+ PROPERTY_TRANSLATION_REQUIRED: "reqTrad";
1534
+ PROPERTY_SIGNATURE_REQUIRED: "reqSign";
1535
+ PROPERTY_SHOW_TOOLTIP_AS_HELP: "tooltipHelp";
1536
+ PROPERTY_DOCUMENT_MONITOR_DEF: "documentMonitorDef";
1537
+ PROPERTY_DOCUMENT_MONITOR_CUS: "documentMonitorCus";
1538
+ PROPERTY_DOCUMENT_SHOW_FOLD_TREE_BTN: "fileShwFoldTreeBtn";
1539
+ PROPERTY_DOCUMENT_SHOW_FOLD_TREE_STR: "fileShwFoldTreeStr";
1540
+ PROPERTY_DOCUMENT_NO_ALLOW_DRAG_DROP: "fileNoAllwDnD";
1541
+ PROPERTY_DOCUMENT_NO_SHOW_MODAL: "fileDntShwDocMdlOnDrop";
1542
+ PROPERTY_DOCUMENT_SHOW_DESC: "fileShowDesc";
1543
+ PROPERTY_DOCUMENT_DEFAULT_FOLDER: "fileDefFolder";
1544
+ PROPERTY_DOCUMENT_ROOT_FOLDER: "fileRootFolder";
1545
+ PROPERTY_DOCUMENT_EXP_DATE: "fileExpDate";
1546
+ PROPERTY_DOCUMENT_DNT_SHW_DOC_MON: "fileNotShowDocMon";
1547
+ PROPERTY_DOCUMENT_COLLAPSE_PERM: "fileCollapsePermission";
1548
+ PROPERTY_DOCUMENT_COLLAPSE_META: "fileCollapseMetadata";
1549
+ PROPERTY_DOCUMENT_COLLAPSE_FLD_STC: "fileCollapseFldStrc";
1550
+ WRONG_ATT_TYPE_ERROR: "Component does not support attributes of type <TOK>. Contact system administrator";
1551
+ STORE_KEY_FIELD: "field";
1552
+ STORE_KEY_FORM: "form";
1553
+ PROPERTY_ARIA_DESCRIPTION: "ariaDescription";
1554
+ PROPERTY_ARIA_LABEL: "ariaLabel";
1555
+ PROPERTY_ALT: "alt";
1556
+ PROPERTY_AUTO_COMPLETE: "autoComplete";
1557
+ PROPERTY_AUTO_FOCUS: "autoFocus";
1558
+ PROPERTY_INPUT_TYPE: "inputType";
1559
+ PROPERTY_PLACE_HOLDER: "placeHolder";
1560
+ PROPERTY_TITLE: "title";
1561
+ }>> | IApiaField<Readonly<{
1562
+ TYPE_INPUT: "input";
1563
+ TYPE_SELECT: "select";
1564
+ TYPE_RADIO: "radio";
1565
+ TYPE_CHECK: "check";
1566
+ TYPE_BUTTON: "button";
1567
+ TYPE_AREA: "area";
1568
+ TYPE_LABEL: "label";
1569
+ TYPE_TITLE: "title";
1570
+ TYPE_FILE: "file";
1571
+ TYPE_MULTIPLE: "multiple";
1572
+ TYPE_HIDDEN: "hidden";
1573
+ TYPE_PASSWORD: "password";
1574
+ TYPE_GRID: "grid";
1575
+ TYPE_IMAGE: "image";
1576
+ TYPE_HREF: "href";
1577
+ TYPE_EDITOR: "editor";
1578
+ TYPE_TREE: "tree";
1579
+ TYPE_CAPTCHA: "captcha";
1580
+ PROPERTY_NAME: "name";
1581
+ PROPERTY_SIZE: "size";
1582
+ PROPERTY_READONLY: "readonly";
1583
+ PROPERTY_DISABLED: "disabled";
1584
+ PROPERTY_MODAL_DISABLED: "modalDisabled";
1585
+ PROPERTY_FONT_COLOR: "fontColor";
1586
+ PROPERTY_VALUE: "value";
1587
+ PROPERTY_REQUIRED: "required";
1588
+ PROPERTY_COLSPAN: "colspan";
1589
+ PROPERTY_ROWSPAN: "rowspan";
1590
+ PROPERTY_MODAL: "modal";
1591
+ PROPERTY_ROWS: "thisRows";
1592
+ PROPERTY_BOLD: "bold";
1593
+ PROPERTY_UNDERLINED: "underlined";
1594
+ PROPERTY_ALIGNMENT: "alignment";
1595
+ PROPERTY_IMAGE: "imageUrl";
1596
+ PROPERTY_COL_WIDTH: "colWidth";
1597
+ PROPERTY_GRID_HEIGHT: "gridHeight";
1598
+ PROPERTY_HIDE_GRID_BTN: "hideGridButtons";
1599
+ PROPERTY_VISIBILITY_HIDDEN: "visibilityHidden";
1600
+ PROPERTY_TRANSIENT: "transient";
1601
+ PROPERTY_GRID_TITLE: "gridTitle";
1602
+ PROPERTY_GRID_FORM: "gridForm";
1603
+ PROPERTY_TOOLTIP: "tooltip";
1604
+ PROPERTY_VALUE_COLOR: "valueColor";
1605
+ PROPERTY_INPUT_AS_TEXT: "inputAsText";
1606
+ PROPERTY_NO_DOWNLOAD: "noDownload";
1607
+ PROPERTY_NO_ERASE: "noErase";
1608
+ PROPERTY_NO_LOCK: "noLock";
1609
+ PROPERTY_NO_HISTORY: "noHistory";
1610
+ PROPERTY_NO_MODIFY: "noModify";
1611
+ PROPERTY_ALLOW_EDITION: "allowEdition";
1612
+ PROPERTY_HIDE_SIGN_ICONS: "hideSignButtons";
1613
+ PROPERTY_URL: "url";
1614
+ PROPERTY_GRID_HIDE_BTN_ORDER: "hideOrderButton";
1615
+ PROPERTY_GRID_HIDE_BTN_INCLUDE: "hideIncludeButton";
1616
+ PROPERTY_REGEXP_MESSAGE: "regExpMessage";
1617
+ PROPERTY_PAGED_GRID: "paged";
1618
+ PROPERTY_PAGED_GRID_SIZE: "pagedGridSize";
1619
+ PROPERTY_GRID_ALTER_IN_LAST_PAGE: "alterOnlyLastPage";
1620
+ PROPERTY_GRID_PRINT_HORIZONTAL: "printHorizontal";
1621
+ PROPERTY_STORE_MODAL_QUERY_RESULT: "storeMdlQryResult";
1622
+ PROPERTY_INCLUDE_FIRST_ROW: "includeFirstRow";
1623
+ PROPERTY_MAX_REG_GRID: "maxRecords";
1624
+ PROPERTY_GRID_LABEL: "gridColTitle";
1625
+ PROPERTY_GRID_QUERY: "gridQuery";
1626
+ PROPERTY_HIDE_DOC_PERMISSIONS: "hideDocPermissions";
1627
+ PROPERTY_VERIFY_SIGNATURE_ONLY: "verifySignatureOnly";
1628
+ PROPERTY_GRID_HIDE_BTN_ADD: "hideAddButton";
1629
+ PROPERTY_GRID_HIDE_BTN_DEL: "hideDelButton";
1630
+ PROPERTY_HIDE_DOC_UPLOAD: "hideDocUpload";
1631
+ PROPERTY_HIDE_DOC_DOWNLOAD: "hideDocDownload";
1632
+ PROPERTY_HIDE_DOC_ERASE: "hideDocErase";
1633
+ PROPERTY_HIDE_DOC_LOCK: "hideDocLock";
1634
+ PROPERTY_HIDE_DOC_HISTORY: "hideDocHistory";
1635
+ PROPERTY_HIDE_DOC_SIGN: "hideSignButtons";
1636
+ PROPERTY_DISPLAY_NONE: "displayNone";
1637
+ PROPERTY_DONT_BREAK_RADIO: "dontBreakRadio";
1638
+ PROPERTY_CHECKED: "checked";
1639
+ PROPERTY_FILE_PREVIEW: "filePreview";
1640
+ PROPERTY_NOT_PRINT: "noPrint";
1641
+ PROPERTY_SELECT_PARENT: "selParent";
1642
+ PROPERTY_HEIGHT: "height";
1643
+ PROPERTY_MULTISELECT: "multiselect";
1644
+ PROPERTY_SEL_PARENT: "selParent";
1645
+ PROPERTY_PARENT_ICON: "parentIcon";
1646
+ PROPERTY_LEAF_ICON: "leafIcon";
1647
+ PROPERTY_CSS_CLASS: "cssClass";
1648
+ PROPERTY_DOC_TYPE: "docType";
1649
+ PROPERTY_HIDE_DOC_METADATA: "hideDocMetadata";
1650
+ PROPERTY_TRANSLATION_REQUIRED: "reqTrad";
1651
+ PROPERTY_SIGNATURE_REQUIRED: "reqSign";
1652
+ PROPERTY_SHOW_TOOLTIP_AS_HELP: "tooltipHelp";
1653
+ PROPERTY_DOCUMENT_MONITOR_DEF: "documentMonitorDef";
1654
+ PROPERTY_DOCUMENT_MONITOR_CUS: "documentMonitorCus";
1655
+ PROPERTY_DOCUMENT_SHOW_FOLD_TREE_BTN: "fileShwFoldTreeBtn";
1656
+ PROPERTY_DOCUMENT_SHOW_FOLD_TREE_STR: "fileShwFoldTreeStr";
1657
+ PROPERTY_DOCUMENT_NO_ALLOW_DRAG_DROP: "fileNoAllwDnD";
1658
+ PROPERTY_DOCUMENT_NO_SHOW_MODAL: "fileDntShwDocMdlOnDrop";
1659
+ PROPERTY_DOCUMENT_SHOW_DESC: "fileShowDesc";
1660
+ PROPERTY_DOCUMENT_DEFAULT_FOLDER: "fileDefFolder";
1661
+ PROPERTY_DOCUMENT_ROOT_FOLDER: "fileRootFolder";
1662
+ PROPERTY_DOCUMENT_EXP_DATE: "fileExpDate";
1663
+ PROPERTY_DOCUMENT_DNT_SHW_DOC_MON: "fileNotShowDocMon";
1664
+ PROPERTY_DOCUMENT_COLLAPSE_PERM: "fileCollapsePermission";
1665
+ PROPERTY_DOCUMENT_COLLAPSE_META: "fileCollapseMetadata";
1666
+ PROPERTY_DOCUMENT_COLLAPSE_FLD_STC: "fileCollapseFldStrc";
1667
+ WRONG_ATT_TYPE_ERROR: "Component does not support attributes of type <TOK>. Contact system administrator";
1668
+ STORE_KEY_FIELD: "field";
1669
+ STORE_KEY_FORM: "form";
1670
+ PROPERTY_ARIA_DESCRIPTION: "ariaDescription";
1671
+ PROPERTY_ARIA_LABEL: "ariaLabel";
1672
+ PROPERTY_ALT: "alt";
1673
+ PROPERTY_AUTO_COMPLETE: "autoComplete";
1674
+ PROPERTY_AUTO_FOCUS: "autoFocus";
1675
+ PROPERTY_INPUT_TYPE: "inputType";
1676
+ PROPERTY_PLACE_HOLDER: "placeHolder";
1677
+ PROPERTY_TITLE: "title";
1678
+ }>>[] | null;
1679
+ getPageCount(): number;
1680
+ getPageSize(): number;
1681
+ getRow(index: number): IApiaField<Readonly<{
1682
+ TYPE_INPUT: "input";
1683
+ TYPE_SELECT: "select";
1684
+ TYPE_RADIO: "radio";
1685
+ TYPE_CHECK: "check";
1686
+ TYPE_BUTTON: "button";
1687
+ TYPE_AREA: "area";
1688
+ TYPE_LABEL: "label";
1689
+ TYPE_TITLE: "title";
1690
+ TYPE_FILE: "file";
1691
+ TYPE_MULTIPLE: "multiple";
1692
+ TYPE_HIDDEN: "hidden";
1693
+ TYPE_PASSWORD: "password";
1694
+ TYPE_GRID: "grid";
1695
+ TYPE_IMAGE: "image";
1696
+ TYPE_HREF: "href";
1697
+ TYPE_EDITOR: "editor";
1698
+ TYPE_TREE: "tree";
1699
+ TYPE_CAPTCHA: "captcha";
1700
+ PROPERTY_NAME: "name";
1701
+ PROPERTY_SIZE: "size";
1702
+ PROPERTY_READONLY: "readonly";
1703
+ PROPERTY_DISABLED: "disabled";
1704
+ PROPERTY_MODAL_DISABLED: "modalDisabled";
1705
+ PROPERTY_FONT_COLOR: "fontColor";
1706
+ PROPERTY_VALUE: "value";
1707
+ PROPERTY_REQUIRED: "required";
1708
+ PROPERTY_COLSPAN: "colspan";
1709
+ PROPERTY_ROWSPAN: "rowspan";
1710
+ PROPERTY_MODAL: "modal";
1711
+ PROPERTY_ROWS: "thisRows";
1712
+ PROPERTY_BOLD: "bold";
1713
+ PROPERTY_UNDERLINED: "underlined";
1714
+ PROPERTY_ALIGNMENT: "alignment";
1715
+ PROPERTY_IMAGE: "imageUrl";
1716
+ PROPERTY_COL_WIDTH: "colWidth";
1717
+ PROPERTY_GRID_HEIGHT: "gridHeight";
1718
+ PROPERTY_HIDE_GRID_BTN: "hideGridButtons";
1719
+ PROPERTY_VISIBILITY_HIDDEN: "visibilityHidden";
1720
+ PROPERTY_TRANSIENT: "transient";
1721
+ PROPERTY_GRID_TITLE: "gridTitle";
1722
+ PROPERTY_GRID_FORM: "gridForm";
1723
+ PROPERTY_TOOLTIP: "tooltip";
1724
+ PROPERTY_VALUE_COLOR: "valueColor";
1725
+ PROPERTY_INPUT_AS_TEXT: "inputAsText";
1726
+ PROPERTY_NO_DOWNLOAD: "noDownload";
1727
+ PROPERTY_NO_ERASE: "noErase";
1728
+ PROPERTY_NO_LOCK: "noLock";
1729
+ PROPERTY_NO_HISTORY: "noHistory";
1730
+ PROPERTY_NO_MODIFY: "noModify";
1731
+ PROPERTY_ALLOW_EDITION: "allowEdition";
1732
+ PROPERTY_HIDE_SIGN_ICONS: "hideSignButtons";
1733
+ PROPERTY_URL: "url";
1734
+ PROPERTY_GRID_HIDE_BTN_ORDER: "hideOrderButton";
1735
+ PROPERTY_GRID_HIDE_BTN_INCLUDE: "hideIncludeButton";
1736
+ PROPERTY_REGEXP_MESSAGE: "regExpMessage";
1737
+ PROPERTY_PAGED_GRID: "paged";
1738
+ PROPERTY_PAGED_GRID_SIZE: "pagedGridSize";
1739
+ PROPERTY_GRID_ALTER_IN_LAST_PAGE: "alterOnlyLastPage";
1740
+ PROPERTY_GRID_PRINT_HORIZONTAL: "printHorizontal";
1741
+ PROPERTY_STORE_MODAL_QUERY_RESULT: "storeMdlQryResult";
1742
+ PROPERTY_INCLUDE_FIRST_ROW: "includeFirstRow";
1743
+ PROPERTY_MAX_REG_GRID: "maxRecords";
1744
+ PROPERTY_GRID_LABEL: "gridColTitle";
1745
+ PROPERTY_GRID_QUERY: "gridQuery";
1746
+ PROPERTY_HIDE_DOC_PERMISSIONS: "hideDocPermissions";
1747
+ PROPERTY_VERIFY_SIGNATURE_ONLY: "verifySignatureOnly";
1748
+ PROPERTY_GRID_HIDE_BTN_ADD: "hideAddButton";
1749
+ PROPERTY_GRID_HIDE_BTN_DEL: "hideDelButton";
1750
+ PROPERTY_HIDE_DOC_UPLOAD: "hideDocUpload";
1751
+ PROPERTY_HIDE_DOC_DOWNLOAD: "hideDocDownload";
1752
+ PROPERTY_HIDE_DOC_ERASE: "hideDocErase";
1753
+ PROPERTY_HIDE_DOC_LOCK: "hideDocLock";
1754
+ PROPERTY_HIDE_DOC_HISTORY: "hideDocHistory";
1755
+ PROPERTY_HIDE_DOC_SIGN: "hideSignButtons";
1756
+ PROPERTY_DISPLAY_NONE: "displayNone";
1757
+ PROPERTY_DONT_BREAK_RADIO: "dontBreakRadio";
1758
+ PROPERTY_CHECKED: "checked";
1759
+ PROPERTY_FILE_PREVIEW: "filePreview";
1760
+ PROPERTY_NOT_PRINT: "noPrint";
1761
+ PROPERTY_SELECT_PARENT: "selParent";
1762
+ PROPERTY_HEIGHT: "height";
1763
+ PROPERTY_MULTISELECT: "multiselect";
1764
+ PROPERTY_SEL_PARENT: "selParent";
1765
+ PROPERTY_PARENT_ICON: "parentIcon";
1766
+ PROPERTY_LEAF_ICON: "leafIcon";
1767
+ PROPERTY_CSS_CLASS: "cssClass";
1768
+ PROPERTY_DOC_TYPE: "docType";
1769
+ PROPERTY_HIDE_DOC_METADATA: "hideDocMetadata";
1770
+ PROPERTY_TRANSLATION_REQUIRED: "reqTrad";
1771
+ PROPERTY_SIGNATURE_REQUIRED: "reqSign";
1772
+ PROPERTY_SHOW_TOOLTIP_AS_HELP: "tooltipHelp";
1773
+ PROPERTY_DOCUMENT_MONITOR_DEF: "documentMonitorDef";
1774
+ PROPERTY_DOCUMENT_MONITOR_CUS: "documentMonitorCus";
1775
+ PROPERTY_DOCUMENT_SHOW_FOLD_TREE_BTN: "fileShwFoldTreeBtn";
1776
+ PROPERTY_DOCUMENT_SHOW_FOLD_TREE_STR: "fileShwFoldTreeStr";
1777
+ PROPERTY_DOCUMENT_NO_ALLOW_DRAG_DROP: "fileNoAllwDnD";
1778
+ PROPERTY_DOCUMENT_NO_SHOW_MODAL: "fileDntShwDocMdlOnDrop";
1779
+ PROPERTY_DOCUMENT_SHOW_DESC: "fileShowDesc";
1780
+ PROPERTY_DOCUMENT_DEFAULT_FOLDER: "fileDefFolder";
1781
+ PROPERTY_DOCUMENT_ROOT_FOLDER: "fileRootFolder";
1782
+ PROPERTY_DOCUMENT_EXP_DATE: "fileExpDate";
1783
+ PROPERTY_DOCUMENT_DNT_SHW_DOC_MON: "fileNotShowDocMon";
1784
+ PROPERTY_DOCUMENT_COLLAPSE_PERM: "fileCollapsePermission";
1785
+ PROPERTY_DOCUMENT_COLLAPSE_META: "fileCollapseMetadata";
1786
+ PROPERTY_DOCUMENT_COLLAPSE_FLD_STC: "fileCollapseFldStrc";
1787
+ WRONG_ATT_TYPE_ERROR: "Component does not support attributes of type <TOK>. Contact system administrator";
1788
+ STORE_KEY_FIELD: "field";
1789
+ STORE_KEY_FORM: "form";
1790
+ PROPERTY_ARIA_DESCRIPTION: "ariaDescription";
1791
+ PROPERTY_ARIA_LABEL: "ariaLabel";
1792
+ PROPERTY_ALT: "alt";
1793
+ PROPERTY_AUTO_COMPLETE: "autoComplete";
1794
+ PROPERTY_AUTO_FOCUS: "autoFocus";
1795
+ PROPERTY_INPUT_TYPE: "inputType";
1796
+ PROPERTY_PLACE_HOLDER: "placeHolder";
1797
+ PROPERTY_TITLE: "title";
1798
+ }>>[] | undefined;
1799
+ getSelection(): IApiaField[][];
1800
+ get id(): string;
1801
+ isPaged(): boolean;
1802
+ get rowsCount(): number;
1803
+ toggleColumnVisibility(fieldName: string, isShown?: boolean): void;
1804
+ toggleDeleteButton(index: number, isShown?: boolean): void;
1805
+ toggleEditFormButton(rowIndex: number, isShown?: boolean): void;
1955
1806
  }
1956
1807
 
1957
- declare global {
1958
- interface Window {
1959
- [key: string]: string;
1960
- }
1961
- interface Document {
1962
- headers: any;
1963
- }
1808
+ type TCaptchaField = IApiaField;
1809
+ declare class CaptchaField extends ApiaField implements TCaptchaField {
1964
1810
  }
1965
- declare function isJsonResponse(response: AxiosResponse<unknown>): RegExpMatchArray | null;
1966
- declare function isXmlResponse(response: AxiosResponse<unknown>): RegExpMatchArray | null;
1967
- declare function isHtmlResponse(response: AxiosResponse<unknown>): RegExpMatchArray | null;
1968
- declare class InvalidSessionException extends Error {
1811
+
1812
+ declare class FileUploaderField extends ApiaFieldWithAttribute {
1813
+ #private;
1814
+ constructor(execution: Execution, field: File$1);
1815
+ onChange(cb: (newValue: unknown) => unknown): void;
1816
+ setValue(): null;
1817
+ }
1818
+
1819
+ declare class PasswordField extends ApiaField {
1820
+ }
1821
+
1822
+ declare class ModalInputField extends ApiaFieldWithAttribute {
1823
+ #private;
1824
+ constructor(execution: Execution, field: ModalInput);
1825
+ getObjectValue(): any | null;
1826
+ setValue(v: any): void;
1827
+ setValueFromInputWrite(value: string): Promise<void>;
1969
1828
  }
1970
- declare const parseSuccessfulResponse: <LoadType extends Record<string, unknown>, DataType = unknown>(execution: Execution, response: AxiosResponse<string>, behaveConfig?: IApiaApiPostConfig<DataType>) => Promise<(ResponseSysMessages & LoadType & {
1971
- onClose?: string;
1972
- code?: unknown;
1973
- load?: LoadType | undefined;
1974
- }) | ({
1975
- actions: unknown;
1976
- onClose: string | undefined;
1977
- exceptions: {
1978
- exception: TApiaMessage | TApiaMessage[];
1979
- } | undefined;
1980
- sysExceptions: {
1981
- exception: TApiaMessage | TApiaMessage[];
1982
- } | undefined;
1983
- sysMessages: {
1984
- message: TApiaMessage | TApiaMessage[];
1985
- } | undefined;
1986
- } & LoadType) | null>;
1987
- /**
1988
- * IMPORTANT!! The ApiaApi is programmed under the slogan that
1989
- * **should never throw an exception**. **Errors** coming from
1990
- * connectivity or exceptions on the server **will be handled
1991
- * automatically** by ApiaApi, using the notification system
1992
- * of the application. It is possible to determine in what context they should
1993
- * be thrown those exceptions (global, main, modal) using the
1994
- * alertsCategory configuration properties **(see errorsHandling.md)**.
1995
- *
1996
- * @param url String, the url you want to call
1997
- * @param config interface IApiaApiRequestConfig<DataType>;
1998
- *
1999
- * @throws Nothing
2000
- *
2001
- * @example
2002
- *
2003
- * ApiaApi.post<ResponseType>('url...', {
2004
- axiosConfig?: AxiosRequestConfig;
2005
1829
 
2006
- // Configuración de postData
2007
- postData? unknown;
2008
- postDataTreatement?: 'stringify' | undefined;
1830
+ type TCreateNewField = (execution: Execution, field: Field | FieldWithAttribute | CustomComponent) => IApiaField | null;
2009
1831
 
2010
- // Configuración de queryString
2011
- queryData?: string | Record<string, unknown>;
2012
- stringifyOptions?: QueryString.IStringifyOptions;
1832
+ declare const createNewField: TCreateNewField;
2013
1833
 
2014
- // Response validator,
2015
- // If it returns true, everything continues correctly
2016
- // If it returns false, the ApiaApi throws a standard error.
2017
- // If it returns string, ApiaApi throws the error returned in the string.
2018
- validateResponse?: (
2019
- response: AxiosResponse<DataType | null>,
2020
- ) => boolean | string;
1834
+ type TCustomComponentState = {
1835
+ isLoading: boolean;
1836
+ attributes: Record<string, any[]>;
1837
+ properties: Record<string, any>;
1838
+ additional: any;
1839
+ component: any;
1840
+ };
1841
+ declare class CustomComponent {
1842
+ #private;
1843
+ execution: Execution;
1844
+ readonly definition: TCustomComponentDefinition;
1845
+ private form;
1846
+ private _state;
1847
+ constructor(execution: Execution, definition: TCustomComponentDefinition);
1848
+ get state(): DeepReadonly<TCustomComponentState>;
1849
+ getAdditional<T>(): DeepReadonly<T>;
1850
+ getCurrentForm(): ApiaForm;
1851
+ init(form: Form): Promise<void>;
1852
+ private parseStateObject;
1853
+ processResult<Result extends Record<string, unknown> = Record<string, unknown>>(res?: TCustomComponentDefaultResponse | null): Promise<(Result & {
1854
+ success: boolean;
1855
+ }) | undefined>;
1856
+ protected getScriptEventParams(fncParams: TFncParams[]): unknown[];
1857
+ protected fireScriptEvents(event: ComponentEvent): Promise<boolean>;
1858
+ fireEvent(evtName: string): Promise<boolean>;
1859
+ getProperty(prpName: string): any;
1860
+ private postMessage;
1861
+ setStringValue(attName: string, value: string): Promise<boolean>;
1862
+ getStringValue(attName: string): string;
1863
+ getValue(attName: string, index?: number): any;
1864
+ getValues(attName: string): any[];
1865
+ removeIndex(attName: string, index: number): Promise<boolean>;
1866
+ setValue(attName: string, value: any, index: number): Promise<boolean>;
1867
+ setProperty(prpName: string, value: any): Promise<boolean>;
1868
+ sendMessage<T extends Record<string, unknown> = Record<string, unknown>>(payload: any): Promise<(T & {
1869
+ success: boolean;
1870
+ }) | undefined>;
1871
+ download(attName: string, index: number): Promise<void>;
1872
+ upload(attName: string, file: File, options?: {
1873
+ onUploadProgress?: (percent: number) => unknown;
1874
+ params?: Record<string, any>;
1875
+ } & Pick<AxiosRequestConfig<any>, 'signal'>): Promise<({
1876
+ index: number;
1877
+ fileName: string;
1878
+ } & {
1879
+ success: boolean;
1880
+ }) | undefined>;
1881
+ setState<K extends keyof TCustomComponentState>(prop: K, value: TCustomComponentState[K]): void;
1882
+ }
2021
1883
 
2022
- // Configuración de alertas
2023
- alertsImportance?: TAlertImportance;
1884
+ declare class Form extends WithProperties<TApiaFormProperties> {
1885
+ execution: Execution;
1886
+ fields: TApiaFieldBaseDefinition<Record<string, any>>[];
1887
+ state: {
1888
+ isMarkedToSign: boolean;
1889
+ };
1890
+ protected _customComponents: Map<string, CustomComponent>;
1891
+ protected fieldsById: Map<string, Field<Record<string, any>, TApiaFieldBaseDefinition<Record<string, any>>, {
1892
+ definition: Omit<TApiaFieldBaseDefinition<Record<string, any>>, "properties">;
1893
+ }>>;
1894
+ protected fieldsByName: Map<string, Field<Record<string, any>, TApiaFieldBaseDefinition<Record<string, any>>, {
1895
+ definition: Omit<TApiaFieldBaseDefinition<Record<string, any>>, "properties">;
1896
+ }>>;
1897
+ protected fieldsByAttributeId: Map<string | number, FieldWithAttribute<Record<string, any>, any, TApiaFieldWithAttributeBaseProps<Record<string, any>>>>;
1898
+ protected fieldsByAttributeName: Map<string, FieldWithAttribute<Record<string, any>, any, TApiaFieldWithAttributeBaseProps<Record<string, any>>>>;
1899
+ protected fieldsGroups: Map<string, Grid>;
1900
+ definition: TApiaForm;
1901
+ constructor(execution: Execution, definition: TApiaForm);
1902
+ get allFields(): Field<Record<string, any>, TApiaFieldBaseDefinition<Record<string, any>>, {
1903
+ definition: Omit<TApiaFieldBaseDefinition<Record<string, any>>, "properties">;
1904
+ }>[];
1905
+ get customComponents(): Map<string, CustomComponent>;
1906
+ closeForm(): void;
1907
+ openForm(): void;
1908
+ getField(field: string, index?: number): Field<TApiaFieldCommonProperties, TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, {
1909
+ definition: Omit<TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, "properties">;
1910
+ }> | Field<Record<string, any>, TApiaFieldBaseDefinition<Record<string, any>>, {
1911
+ definition: Omit<TApiaFieldBaseDefinition<Record<string, any>>, "properties">;
1912
+ }> | FieldWithAttribute<Record<string, any>, any, TApiaFieldWithAttributeBaseProps<Record<string, any>>> | Field<TApiaFieldCommonProperties, TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, {
1913
+ definition: Omit<TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, "properties">;
1914
+ }>[] | undefined;
1915
+ getFieldByAttributeId(attId: string | number, index?: number): Field<TApiaFieldCommonProperties, TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, {
1916
+ definition: Omit<TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, "properties">;
1917
+ }> | FieldWithAttribute<Record<string, any>, any, TApiaFieldWithAttributeBaseProps<Record<string, any>>> | Field<TApiaFieldCommonProperties, TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, {
1918
+ definition: Omit<TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, "properties">;
1919
+ }>[] | undefined;
1920
+ getFieldByAttributeName(attName: string, index?: number): Field<TApiaFieldCommonProperties, TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, {
1921
+ definition: Omit<TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, "properties">;
1922
+ }> | FieldWithAttribute<Record<string, any>, any, TApiaFieldWithAttributeBaseProps<Record<string, any>>> | Field<TApiaFieldCommonProperties, TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, {
1923
+ definition: Omit<TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, "properties">;
1924
+ }>[] | undefined;
1925
+ getFieldById(id: string | number, index?: number): Field<TApiaFieldCommonProperties, TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, {
1926
+ definition: Omit<TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, "properties">;
1927
+ }> | Field<Record<string, any>, TApiaFieldBaseDefinition<Record<string, any>>, {
1928
+ definition: Omit<TApiaFieldBaseDefinition<Record<string, any>>, "properties">;
1929
+ }> | Field<TApiaFieldCommonProperties, TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, {
1930
+ definition: Omit<TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, "properties">;
1931
+ }>[] | undefined;
1932
+ getFieldByName(name: string, index?: number): Field | Field[] | undefined;
1933
+ protected getHiddenFields(): Field<Record<string, any>, TApiaFieldBaseDefinition<Record<string, any>>, {
1934
+ definition: Omit<TApiaFieldBaseDefinition<Record<string, any>>, "properties">;
1935
+ }>[];
1936
+ markFormToSign(): Promise<void>;
1937
+ viewSigns(): Promise<TSignaturesData | undefined>;
1938
+ private cucCmpByAttId;
1939
+ private cucCmpByFldId;
1940
+ private cucCmpByAttName;
1941
+ private mustRenderFields;
1942
+ getCustomComponentByFldId(fldId: number): CustomComponent | undefined;
1943
+ getCustomComponentByAttId(attId: number): CustomComponent | undefined;
1944
+ getCustomComponentByAttName(attName: string): CustomComponent | undefined;
1945
+ addFieldToRender(fldId: string, fldIndex?: number): void;
1946
+ markFieldAsRendered(fldId: string, fldIndex?: number): void;
1947
+ init(): Promise<void>;
1948
+ protected getScriptEventParams(fncParams: TFncParams[]): Promise<unknown[]>;
1949
+ fireScriptEvent(eventName: TFormEventName): Promise<boolean>;
1950
+ validate(): Promise<true | Field>;
1951
+ getProperty<K extends keyof TApiaFormProperties>(propName: K | 'readOnly'): TApiaFormProperties[K];
1952
+ }
2024
1953
 
2025
- // Configuración de ApiaApiHandler, falta documentar
2026
- handleLoad?: boolean;
2027
- eventsHandler?: IEventsHandler;
1954
+ type TTranslationState = {
1955
+ id: string;
1956
+ label: string;
1957
+ hasChanged: boolean;
1958
+ isTranslated: boolean;
1959
+ remoteValue?: string;
1960
+ tempValue: string;
1961
+ };
2028
1962
 
2029
- // other configuration
2030
- colors?: TColors;
2031
- debug?: boolean;
2032
- }
2033
- * @returns The type of the return value depends on the type passed when calling the function. If there was an error it returns null.
2034
- */
2035
- declare function post<LoadType extends Record<string, unknown> = Record<string, unknown>, DataType = unknown, T = unknown>(execution: Execution, actualUrl: string, behaveConfig?: IApiaApiPostConfig<DataType>): TApiaApiResult<LoadType>;
2036
- /**
2037
- * IMPORTANTE!! El ApiaApi está programado bajo la consigna de que
2038
- * **no debe tirar núnca una excepción**. **Los errores** provenientes
2039
- * de la conectividad o de excepciones en el servidor **serán manejados
2040
- * automáticamente** por el ApiaApi utilizando el sistema de notificaciones
2041
- * de la aplicación. Es posible determinar en qué contexto deben
2042
- * ser lanzadas esas excepciones (global, main, modal) utilizando las
2043
- * propiedades de configuración alertsCategory **(ver errorsHandling.md)**.
2044
- *
2045
- * @param url String, el url al que se desea llamar
2046
- * @param config interface IApiaApiRequestConfig<DataType>;
2047
- *
2048
- * @throws Nothing
2049
- *
2050
- * @example
2051
- *
2052
- * ApiaApi.get<TipoDeRespuesta>('url...', {
2053
- axiosConfig?: AxiosRequestConfig;
1963
+ declare class Translation {
1964
+ execution: Execution;
1965
+ state: TTranslationState;
1966
+ constructor(execution: Execution, state: Pick<TTranslationState, 'id' | 'label' | 'isTranslated'>);
1967
+ cancelTranslation(): void;
1968
+ readTranslations(url: string): Promise<void>;
1969
+ reset(): void;
1970
+ deleteTranslation(): void;
1971
+ setTempValue(str: string): void;
1972
+ submitTranslation(value: string, url: string): void;
1973
+ get langId(): string;
1974
+ get value(): string;
1975
+ }
2054
1976
 
2055
- // Configuración de queryString
2056
- queryData?: string | Record<string, unknown>;
2057
- stringifyOptions?: QueryString.IStringifyOptions;
1977
+ interface InitialTradMap {
1978
+ [key: string]: boolean;
1979
+ }
1980
+ declare abstract class TranslatableField<FieldProps extends TApiaTranslatableFieldProperties = TApiaTranslatableFieldProperties, ValueType = any, FieldDefinition extends TApiaFieldWithAttributeBaseProps<FieldProps> = TApiaFieldWithAttributeBaseProps<FieldProps>> extends FieldWithAttribute<FieldProps, ValueType, FieldDefinition> {
1981
+ translations: Map<string, Translation>;
1982
+ selectedLanguageId: string;
1983
+ isTradLoading: boolean;
1984
+ definitionTradParsed: InitialTradMap;
1985
+ constructor(props: TApiaFieldWithAttributeBaseProps<FieldProps>);
1986
+ private extractTrad;
1987
+ private getLanguages;
1988
+ init(form: Form): Promise<void>;
1989
+ cancelTranslations(): void;
1990
+ deleteTranslations(): void;
1991
+ changeLanguage(langId: string): Promise<void>;
1992
+ getTranslation(id: string): Translation | undefined;
1993
+ getCurrentTranslation(): Translation | undefined;
1994
+ getTranslations(): Map<string, Translation>;
1995
+ submitTranslations(): void;
1996
+ syncTranslation(): Promise<void>;
1997
+ validate(): Promise<boolean>;
1998
+ setValue(newValue: ValueType, options?: Partial<{
1999
+ comparator: Comparator$1<any>;
2000
+ format: 'd/m/Y' | 'apia';
2001
+ markAsDirty: boolean;
2002
+ synchronize: boolean;
2003
+ }> | undefined): Promise<boolean>;
2004
+ }
2058
2005
 
2059
- // Validador de respuesta,
2060
- // Si devuelve true, todo sigue correctamente
2061
- // Si devuelve false, el ApiaApi tira un error estándar.
2062
- // Si devuelve string, el ApiaApi tira el error devuelto en el string.
2063
- validateResponse?: (
2064
- response: AxiosResponse<DataType | null>,
2065
- ) => boolean | string;
2006
+ type FieldConstructor = new (definition: any) => Field<any, any, any> | FieldWithAttribute<any, any, any> | TranslatableField<any, any, any>;
2007
+ type FieldsMapping = Record<string, (definition: any) => FieldConstructor>;
2066
2008
 
2067
- // Configuración de alertas
2068
- alertsImportance?: TAlertImportance;
2009
+ type NotificationIcon = string;
2010
+ type NotificationType = 'info' | 'error' | 'success' | 'warning';
2011
+ type NotificationDefinition = {
2012
+ icon?: NotificationIcon;
2013
+ id?: string | number;
2014
+ isOpen?: boolean;
2015
+ message: string;
2016
+ stackTrace?: string;
2017
+ title?: string;
2018
+ type?: NotificationType;
2019
+ };
2020
+ declare abstract class Notification<State extends NotificationDefinition = NotificationDefinition> {
2021
+ readonly props: State;
2022
+ protected state: State;
2023
+ constructor(props: State);
2024
+ get icon(): string | undefined;
2025
+ get id(): string | number | undefined;
2026
+ get isOpen(): boolean | undefined;
2027
+ get message(): string;
2028
+ get stackTrace(): string | undefined;
2029
+ get title(): string | undefined;
2030
+ get type(): NotificationType | undefined;
2031
+ }
2069
2032
 
2070
- // Configuración de ApiaApiHandler, falta documentar
2071
- handleLoad?: boolean;
2072
- eventsHandler?: IEventsHandler;
2033
+ declare class Notifications {
2034
+ execution: Execution;
2035
+ private emitter;
2036
+ constructor(execution: Execution);
2037
+ protected notifications: Notification[];
2038
+ add(notification: Notification): void;
2039
+ closeTab(): void;
2040
+ getAll(): Notification<NotificationDefinition>[];
2041
+ getById(id: string | number): Notification<NotificationDefinition> | undefined;
2042
+ kill(): void;
2043
+ remove(notification: string | number | Notification): void;
2044
+ on: <K extends "closeTab" | "kill" | "notification">(event: K, cb: Callback<{
2045
+ closeTab: null;
2046
+ kill: null;
2047
+ notification: Notification;
2048
+ }, K>) => UnSubscriber;
2049
+ }
2073
2050
 
2074
- // Otra configuración
2075
- colors?: TColors;
2076
- debug?: boolean;
2077
- }
2078
- * @returns El tipo del valor devuelto depende del tipo pasado al llamar a la función. Si hubo un error devuelve null
2079
- */
2080
- declare function get<LoadType extends Record<string, unknown> = Record<string, unknown>, T = unknown, D = unknown>(execution: Execution, actualUrl: string, behaveConfig?: IApiaApiRequestConfig): TApiaApiResult<LoadType>;
2081
- type MakeApiaUrlProps = {
2082
- action?: string;
2083
- ajaxUrl?: string;
2084
- queryString?: string;
2085
- stringifyOptions?: IStringifyOptions;
2086
- tabId?: string | number;
2087
- preventAsXmlParameter?: boolean;
2088
- avoidTabId?: boolean;
2089
- [key: string]: unknown;
2051
+ type TProcess = {
2052
+ calendar: {
2053
+ fixed: boolean;
2054
+ label: string;
2055
+ name: string;
2056
+ options: {
2057
+ label: string;
2058
+ value: string;
2059
+ selected: boolean;
2060
+ }[];
2061
+ toolTip: string;
2062
+ value: string;
2063
+ viewButton: {
2064
+ label: string;
2065
+ toolTip: string;
2066
+ };
2067
+ };
2068
+ comments: {
2069
+ currentComment: string;
2070
+ addMarker: boolean;
2071
+ markAll: boolean;
2072
+ deleteMarker: boolean;
2073
+ history: {
2074
+ comment: string;
2075
+ marked: boolean;
2076
+ date: string;
2077
+ user: string;
2078
+ }[];
2079
+ };
2080
+ identifier: {
2081
+ body: {
2082
+ name: string;
2083
+ required: boolean;
2084
+ toolTip: string;
2085
+ type: 'fixed' | 'custom';
2086
+ value: string;
2087
+ };
2088
+ label: string;
2089
+ prefix: {
2090
+ label: string;
2091
+ name: string;
2092
+ toolTip: string;
2093
+ type: 'fixed' | 'custom' | 'none';
2094
+ value: string;
2095
+ };
2096
+ required: boolean;
2097
+ suffix: {
2098
+ label: string;
2099
+ name: string;
2100
+ toolTip: string;
2101
+ type: 'fixed' | 'custom' | 'none';
2102
+ value: string;
2103
+ };
2104
+ toolTip: string;
2105
+ value: string;
2106
+ };
2107
+ priority: {
2108
+ disabled: boolean;
2109
+ isMonitor: boolean;
2110
+ label: string;
2111
+ name: string;
2112
+ options: {
2113
+ label: string;
2114
+ value: string;
2115
+ selected: boolean;
2116
+ }[];
2117
+ toolTip: string;
2118
+ value: string;
2119
+ };
2120
+ process: {
2121
+ label: string;
2122
+ toolTip: string;
2123
+ value: string;
2124
+ };
2125
+ processAction: {
2126
+ label: string;
2127
+ toolTip: string;
2128
+ value: string;
2129
+ };
2130
+ separator: string;
2131
+ status?: {
2132
+ label: string;
2133
+ toolTip: string;
2134
+ value: string;
2135
+ };
2136
+ title: string;
2137
+ user: {
2138
+ label: string;
2139
+ toolTIp: string;
2140
+ value: string;
2141
+ };
2090
2142
  };
2143
+
2091
2144
  /**
2092
- * Creates an url based on the general requirements of Apia.
2093
- * If the ajaxUrl property is not passed, it will use the
2094
- * getWindow(execution).URL_REQUEST_AJAX. Its use is very simple, just pass the objects you
2095
- * want to appear in the query string.
2096
- *
2097
- * @example makeApiaUrl({
2098
- * ajaxUrl: 'the.endpoint.you.want',
2099
- * queryString: 'an=existent&query=string',
2100
- * action: 'theAction',
2101
- * anotherProp: 15
2102
- * })
2103
- *
2104
- * @returns the well formed url, in the example, the response url is:
2105
- * /context/the.endpoint.you.want?an=existent&query=string&anotherProp=15&tabId=...&tokenId=...&action=theAction
2145
+ * El comportamiento de esta función se explica por su
2146
+ * nombre.
2106
2147
  */
2107
- declare function makeApiaUrl(execution: Execution, props?: MakeApiaUrlProps): string;
2108
-
2109
- interface IIProperty {
2110
- [key: string]: string;
2111
- }
2112
- interface IApiaFunctions {
2113
- getLastModalReturn: () => string[];
2114
- getModalReturn: () => string[];
2115
- getModalValue: () => string;
2116
- getModalShowValue: () => string;
2117
- setLastModalReturn: (value: string[]) => void;
2118
- getModalSelectedRow: () => string[];
2119
- getForm(frmName: string, frmType?: string): IApiaForm | null;
2120
- getAllForms(): IApiaForm[];
2121
- getEntityForm(frmName: string): IApiaForm | null;
2122
- getProcessForm(frmName: string): IApiaForm | null;
2123
- getAttField(attType: 'P' | 'E', attId: string): IApiaField | IApiaField[] | undefined;
2124
- setStepTitle(stepNumber: number, stepTitle: string): void;
2125
- getCurrentStep(): number | null;
2126
- getCurrentTaskName(): string | null;
2127
- getCurrentProcessName(): string | null;
2128
- getRootPath(): string | null;
2129
- getCurrentLanguageCode(): string | null;
2130
- toJSNumber(value: string): number | string;
2131
- toApiaNumber(value: number): number | string;
2132
- disableActionButton(btnIdx: string): void;
2133
- enableActionButton(btnIdx: string): void;
2134
- disableOptionButton(btnIdx: string): void;
2135
- enableOptionButton(btnIdx: string): void;
2136
- hideOptionButton(btnIdx: string): void;
2137
- showOptionButton(btnIdx: string): void;
2138
- openTab(title: string, url: string): void;
2139
- showMessage(text: string): void;
2140
- showConfirm(text: string, title: string, callbackFn: (win: boolean) => unknown): void;
2141
- }
2142
- interface IApiaForm {
2143
- getFrmId(): string | null;
2144
- getFrmParent(): string;
2145
- getFormName(): string;
2146
- getFormTitle(): string;
2147
- openForm(): void;
2148
- closeForm(): void;
2149
- getProperty<K extends keyof TApiaFormProperties>(name: K): TApiaFormProperties[K];
2150
- setProperty<K extends keyof TApiaFormProperties>(name: K, value: TApiaFormProperties[K]): void;
2151
- getField(fld: number | string, index?: number): IApiaField | undefined;
2152
- getFieldColumn(fldName: string): IApiaField[];
2153
- getAllFields(): IApiaField[];
2154
- clearForm(clearReadonlyFields: boolean, deleteGridsRows: boolean): void;
2155
- }
2156
- interface IApiaField<Props extends TApiaFieldCommonProperties = TApiaFieldCommonProperties> {
2157
- get fldType(): TApiaFieldType;
2158
- get fldId(): string;
2159
- /**
2160
- * Assigns a new value to the property whoose name's correspond to that determined by the name paremeter.
2161
- */
2162
- setProperty<K extends keyof Props>(name: K, value: Props[K]): void;
2163
- /**
2164
- * Returns the current value of the property determined by the name in the paremeter.
2165
- */
2166
- getProperty<K extends keyof Props>(name: K): Props[K];
2148
+ declare function returnExactlyTheSame(defaultParameters: Record<string, unknown>): Record<string, unknown>;
2149
+ declare function isOneClickUploadEnabled(execution: Execution, oneClickUploadProp?: boolean): string | boolean;
2150
+ declare const parseFileDefinition: (execution: Execution, fileDefinition: TFileUploaded | TUploaderFileInfo, isSignRequired: boolean) => TUploaderFileInfo;
2151
+ type TOnUploadProgress = (progress: number) => void;
2152
+ declare class UploaderApi extends EventEmitter$1<{
2153
+ fileUploaded: null;
2154
+ }> {
2155
+ execution: Execution;
2156
+ id: string;
2157
+ type: 'E' | 'P';
2158
+ modalConfig: TModalConfig;
2159
+ maxFiles: number;
2160
+ modalController: UploaderModalController | null;
2161
+ allowTranslations: boolean;
2162
+ langs: Record<number, string> | undefined;
2163
+ currentConfiguration: TUploaderLoadCurrentFunctionMessages | undefined;
2164
+ docTypePermittedObjId: string | undefined;
2165
+ state: UploaderState;
2166
+ get filesArray(): TUploaderFileInfo[];
2167
+ constructor(execution: Execution, id: string, type: 'E' | 'P', modalConfig: TModalConfig);
2168
+ init(): Promise<void>;
2169
+ onStartUpload(files?: File[]): Promise<void>;
2170
+ onTranslateUpload(conf: {
2171
+ langId: number;
2172
+ translatingFile: TUploaderFileInfo;
2173
+ }, files?: File[]): Promise<void>;
2174
+ onVersionUpload(file: TUploaderFileInfo, conf?: {
2175
+ newFiles?: File[];
2176
+ langId?: number;
2177
+ translatingFile?: TUploaderFileInfo;
2178
+ }): Promise<void>;
2179
+ autoLock(): Promise<boolean>;
2180
+ notify(notification: NotificationDefinition): void;
2181
+ protected getAjaxUrl(): string;
2182
+ getDocTypes(): TDocType[];
2183
+ getCurrentDocTypeId(): string;
2184
+ getCurrentDocType(): TDocType | undefined;
2185
+ getInProgressFiles(): File[];
2186
+ getHiddenFiles(): File[];
2187
+ getExistingFiles(): Record<string, TUploaderFileInfo>;
2188
+ getProgress(): number;
2189
+ getHasAllDocTypes(): boolean | undefined;
2190
+ getDocumentInfo({ docId: apiId, downloadDocId: docId, }: TRequireOnlyOne<{
2191
+ docId: string;
2192
+ downloadDocId: string;
2193
+ }>, newElem?: boolean): Promise<({
2194
+ canClose: boolean;
2195
+ type: string;
2196
+ } & {
2197
+ function: {
2198
+ name: string;
2199
+ } & {
2200
+ data: {
2201
+ onClose: string;
2202
+ general: TApiaDocumentDefinition;
2203
+ permissions: {
2204
+ pool: TDocumentPermission | TDocumentPermission[];
2205
+ user: TDocumentPermission | TDocumentPermission[];
2206
+ };
2207
+ versions: {
2208
+ version: TDocumentVersion | TDocumentVersion[];
2209
+ };
2210
+ };
2211
+ currentUsrPems: {
2212
+ usrCanModify: boolean;
2213
+ };
2214
+ metadatas: {
2215
+ metadata: TDocumentMetadata | TDocumentMetadata[];
2216
+ };
2217
+ docDownHistory: {
2218
+ docHistory: TDocumentDownloadHistory | TDocumentDownloadHistory[];
2219
+ };
2220
+ };
2221
+ } & ResponseSysMessages) | null>;
2167
2222
  /**
2168
- * Sets the focus on the field if possible.
2223
+ * This method searches for the provided id in several places:
2224
+ *
2225
+ * If it's found in the current files, returns it.
2226
+ * If not, it searches the provided docId in the translations map of each uploaded file.
2169
2227
  */
2170
- setFocus(): void;
2228
+ getDocument(docId: string): TUploaderFileInfo | undefined;
2229
+ protected updateDocument(docId: string, newValue: TUploaderFileInfo): void;
2230
+ protected deleteDocument(docId: string): void;
2231
+ clearFile(name: string): void;
2232
+ clearFiles(): void;
2233
+ clearState(): void;
2234
+ checkLockDocument(id: string, shouldNotifyUnlocked?: boolean): Promise<string | boolean>;
2235
+ setCurrentDocTypeId(docTypeId: string): void;
2236
+ ajaxUploadStart(newFiles?: File[]): Promise<boolean | undefined>;
2237
+ reloadMetadata(props?: Partial<{
2238
+ docId: string;
2239
+ docTypeId: number | string;
2240
+ }>, additionalProps?: Record<string, unknown>): Promise<void>;
2241
+ saveDroppedFiles(unprocessedFiles: File[], conf?: TSaveDroppedFilesConf): Promise<boolean>;
2242
+ checkWebDavLock(docId: string): Promise<unknown>;
2243
+ checkSignature(file: TUploaderFileInfo): Promise<TApiaApiAxiosResponse<({
2244
+ markedToSign: boolean;
2245
+ } & ResponseSysMessages) | null> | null>;
2246
+ editDocument(id: string): Promise<void>;
2247
+ downloadDocument(id: string, version?: string): Promise<void>;
2248
+ ajaxDeleteDocument(id: string, langId?: number): Promise<void>;
2249
+ version(file: TUploaderFileInfo, conf?: {
2250
+ newFiles?: File[];
2251
+ langId?: number;
2252
+ translatingFile?: TUploaderFileInfo;
2253
+ }): Promise<void>;
2254
+ versionFileInfo(file: TUploaderFileInfo): Promise<void>;
2255
+ pickFileById(id: string): Promise<void>;
2256
+ markFileToSign(id: string, langId?: string): Promise<void>;
2171
2257
  /**
2172
- * Returns true if the field is part of a grid.
2258
+ * Por el momento realiza la descarga de todos los archivos
2259
+ * que estén subidos.
2173
2260
  */
2174
- isInGrid(): boolean;
2261
+ downloadMultipleDocuments(): void;
2262
+ confirmDropModal(conf?: {
2263
+ langId?: number;
2264
+ translatingFile?: TUploaderFileInfo;
2265
+ }): Promise<boolean>;
2266
+ loadCurrentDocuments(): Promise<void>;
2267
+ lockDocument(id: string): Promise<void>;
2268
+ protected evaluateDeleteDocumentResult(result: unknown): boolean;
2269
+ setTranslationFile(file: TUploaderFileInfo, docId: string, langId: number): void;
2270
+ protected getAjaxUploadFileStatusParameters: typeof returnExactlyTheSame;
2271
+ protected getAjaxUploadStartParameters: typeof returnExactlyTheSame;
2272
+ protected getConfirmDropModalParameters: typeof returnExactlyTheSame;
2273
+ protected getCheckLockDocumentParameters: typeof returnExactlyTheSame;
2274
+ protected getCheckWebDavLockParameters: typeof returnExactlyTheSame;
2275
+ protected getConfirmDropModalPostdata: typeof returnExactlyTheSame;
2276
+ protected getConfirmDropModalMetadataString: ({ metadata, }: {
2277
+ metadata: TDocumentMetadata[];
2278
+ }) => string;
2279
+ protected getConfirmDropModalPermissionsString: ({ poolsPermissions, usersPermissions, }: {
2280
+ poolsPermissions: IPoolsPermissions[];
2281
+ usersPermissions: IUsersPermissions[];
2282
+ }) => string;
2283
+ protected getConfirmDropModalAdditionalMetadataString: (additionalMetadata: TDocumentMetadata[] | []) => string;
2284
+ protected getDeleteDocumentParameters: typeof returnExactlyTheSame;
2285
+ protected getClearTempFilesParameters: typeof returnExactlyTheSame;
2286
+ protected getDocumentInfoParameters: typeof returnExactlyTheSame;
2287
+ protected getDownloadMultipleDocumentsParameters: typeof returnExactlyTheSame;
2288
+ protected getEditDocumentParameters: typeof returnExactlyTheSame;
2289
+ protected getLockDocumentParameters: typeof returnExactlyTheSame;
2290
+ protected getMarkFileToSignParameters: typeof returnExactlyTheSame;
2291
+ protected getProcessDroppedFilesParameters: typeof returnExactlyTheSame;
2292
+ protected getProcessDroppedFilesPostdata: typeof returnExactlyTheSame;
2293
+ protected getReloadMetadataParameters: typeof returnExactlyTheSame;
2294
+ protected getSaveDroppedFilesParameters: typeof returnExactlyTheSame;
2295
+ protected filterAlreadyUploadedFiles(files: File[], conf?: TSaveDroppedFilesConf): File[];
2296
+ protected filterByFilesAmountLimit(files: File[]): File[];
2297
+ protected filterAcceptedFiles(files: File[], shouldNotify?: boolean, docTypeId?: string | TDocType): File[];
2298
+ protected filterExistingFiles(files: File[], conf?: TSaveDroppedFilesConf): File[];
2299
+ protected filterVersioningFiles(files: File[], conf?: {
2300
+ langId?: number;
2301
+ strictMode?: boolean;
2302
+ translatingFile?: TUploaderFileInfo;
2303
+ shouldReset?: boolean;
2304
+ }): File[];
2305
+ parseFileDefinition: (file: TFileUploaded) => TUploaderFileInfo;
2306
+ getLoadFileSystemStructureTree: () => Record<string, unknown>;
2175
2307
  }
2176
- interface IButton {
2177
- disabled: boolean;
2178
- hidden: boolean;
2179
- label: string;
2180
- isLoading: boolean;
2181
- title: string;
2182
- variant?: string;
2183
- action: Promise<() => unknown> | string;
2184
- id: TActionButtons;
2308
+
2309
+ declare class UploaderModalController {
2310
+ api: UploaderApi;
2311
+ modalConfig: TModalConfig;
2312
+ conf?: {
2313
+ langId?: number;
2314
+ translatingFile?: TUploaderFileInfo;
2315
+ versionFile?: TUploaderFileInfo;
2316
+ } | undefined;
2317
+ state: UploaderModalState;
2318
+ constructor(api: UploaderApi, modalConfig: TModalConfig, conf?: {
2319
+ langId?: number;
2320
+ translatingFile?: TUploaderFileInfo;
2321
+ versionFile?: TUploaderFileInfo;
2322
+ } | undefined);
2323
+ get allMetadata(): TDocumentMetadata[];
2324
+ get allowAllType(): "" | "M" | "R";
2325
+ get description(): string;
2326
+ get docFolder(): number | undefined;
2327
+ get docExpDate(): string | undefined;
2328
+ get docTypes(): TDocType[];
2329
+ get freeMetadata(): TDocumentMetadata[];
2330
+ get exitingFiles(): Record<string, TUploaderFileInfo>;
2331
+ get inProgressFiles(): File[];
2332
+ get hiddenFiles(): File[];
2333
+ get progress(): number;
2334
+ get metadata(): TDocumentMetadata[];
2335
+ get selectedDocTypeId(): string;
2336
+ get selectedDocType(): TDocType | undefined;
2337
+ addMetadata(): void;
2338
+ addFiles(files: File[]): void;
2339
+ addDirectoryFile(file: TApiaDocumentDefinition): void;
2340
+ changeDocType(docTypeId: string): Promise<void>;
2341
+ clearDirectoryFile(): void;
2342
+ clearFile(name: string): void;
2343
+ clearFiles(): void;
2344
+ clearState(): void;
2345
+ clearPartialState(): void;
2346
+ onCloseModal(): void;
2347
+ confirm(): Promise<boolean>;
2348
+ deleteMetadata(indices: number[]): void;
2349
+ deletePermission(item: IPoolsPermissions | IUsersPermissions): void;
2350
+ protected onChangeExtension(): void;
2351
+ openModal(): Promise<void>;
2352
+ setDescription(desc: string): void;
2353
+ protected resetMetadata(): Promise<void>;
2354
+ validate(): boolean;
2185
2355
  }
2186
- type TActionButtons = 'sbtEjeDoc' | 'btnClose' | 'lblExeDelegar' | 'btnCon' | 'btnSig' | 'btnStaPri' | 'btnAnt' | 'btnEjeLib' | 'btnGua' | 'SIGN' | 'lblShareMsg';
2187
- type TApiaFieldType = 'area' | 'button' | 'captcha' | 'check' | 'editor' | 'file' | 'grid' | 'hidden' | 'href' | 'image' | 'input' | 'label' | 'multiple' | 'password' | 'radio' | 'select' | 'title' | 'tree' | 'form';
2188
- type PossibleValue = {
2189
- value: string | number;
2190
- label: string;
2191
- selected?: boolean;
2356
+
2357
+ type TUploadModalOpener = (controller: UploaderModalController) => void;
2358
+ type UploaderModalState = {
2359
+ fileReqError: boolean;
2360
+ metadata: {
2361
+ metadataArray: TDocumentMetadata[];
2362
+ isFreeMetadata: boolean;
2363
+ freeMetadataArray: TDocumentMetadata[];
2364
+ };
2365
+ fromDirectoryFile: TApiaDocumentDefinition | null;
2366
+ docFolder?: number;
2367
+ docPath?: string;
2368
+ docExpDate?: string;
2369
+ description: string;
2370
+ isReadonly?: boolean;
2371
+ permissions: {
2372
+ allowAllType: 'M' | 'R' | '';
2373
+ users: IUsersPermissions[];
2374
+ pools: IPoolsPermissions[];
2375
+ };
2376
+ };
2377
+ type UploaderState = {
2378
+ progress: number;
2379
+ allowedTypes: TDocType[];
2380
+ selectedDocTypeId: string;
2381
+ versioningFile: TUploaderFileInfo | null;
2382
+ inProgressFiles: File[];
2383
+ hiddenFiles: File[];
2384
+ files: Record<string, TUploaderFileInfo>;
2385
+ translatedFiles: Map<string, Map<number, TUploaderFileInfo>>;
2386
+ hasAllDocTypes?: boolean;
2387
+ selectedFiles: string[];
2388
+ };
2389
+ interface IUsersPermissions {
2390
+ userId: string;
2391
+ userLogin: string;
2392
+ canUpdate: boolean;
2393
+ }
2394
+ interface IPoolsPermissions {
2395
+ poolId: string;
2396
+ poolName: string;
2397
+ canUpdate: boolean;
2398
+ }
2399
+ type TUploaderFileInfo = Omit<TFileUploaded, 'locked' | 'userLocking'> & {
2400
+ canEdit?: boolean;
2401
+ canRead?: boolean;
2402
+ isLocked: boolean;
2403
+ isLockedByMe: boolean;
2404
+ isVirtual: boolean;
2405
+ lockingUser: string;
2406
+ };
2407
+ type TFileUploaded = {
2408
+ canEdit?: boolean;
2409
+ canWrite?: boolean;
2410
+ canRead?: boolean;
2411
+ description?: string;
2412
+ docDescription?: string;
2413
+ docId: string;
2414
+ docLang?: string;
2415
+ docLangGroup?: string;
2416
+ docName?: string;
2417
+ docSize?: string;
2418
+ docTypeFreeMetadata?: boolean;
2419
+ docTypeId?: string;
2420
+ docTypeLabel?: string;
2421
+ docTypeTitle: string;
2422
+ downloadDocId: string;
2423
+ isMarkedToSign: boolean;
2424
+ markedToSign: boolean;
2425
+ lock?: string | boolean;
2426
+ isLocked?: string | boolean;
2427
+ lockedBy?: string;
2428
+ name?: string;
2429
+ onlyInformation: boolean;
2430
+ prefix: string;
2431
+ preview: string;
2432
+ sign?: string | boolean;
2433
+ size?: string;
2434
+ userLocking: string;
2435
+ virtualDoc?: boolean;
2436
+ };
2437
+ type TAjaxUploadStart = TApiaLoad<TApiaFunction<{
2438
+ general: {
2439
+ isDocTypeDisabled: boolean;
2440
+ useDocTypePermitted: boolean;
2441
+ createMode: boolean;
2442
+ allowAllTypes: string;
2443
+ allDocTypes: boolean;
2444
+ };
2445
+ docTypes: {
2446
+ docType: TDocType | TDocType[];
2447
+ };
2448
+ metadatas: {
2449
+ metadata: TDocumentMetadata | TDocumentMetadata[];
2450
+ };
2451
+ }, false>>;
2452
+ type TDocType = {
2453
+ docExts: string;
2454
+ maxSize: number;
2455
+ id: string;
2456
+ title: string;
2457
+ free: boolean;
2458
+ selected: boolean;
2459
+ };
2460
+ type TDocumentMetadata = {
2461
+ free: string;
2462
+ id: string;
2463
+ name: string;
2464
+ required: 'Y' | 'N';
2465
+ title: string;
2466
+ type: 'S' | 'N' | 'D';
2467
+ value: string;
2468
+ errorMessage: string;
2469
+ labelErrorMessage: string;
2470
+ };
2471
+ type TModalConfig = {
2472
+ allowDocumentsMonitor: boolean;
2473
+ allowPickFromDirectories: boolean;
2474
+ collapsePermissions: boolean;
2475
+ collapseDirectories: boolean;
2476
+ collapseMetadata: boolean;
2477
+ defaultDirectory?: number;
2478
+ monitorId?: number;
2479
+ oneClickUpload: boolean;
2480
+ rootFolder?: string;
2481
+ showDirectoriesStructure: boolean;
2482
+ showExpDate: boolean;
2483
+ showPermissions: boolean;
2484
+ showMetadata: boolean;
2485
+ translationId?: string;
2192
2486
  };
2193
-
2194
- declare class ButtonsAction {
2195
- private button;
2196
- constructor(button: IButton);
2197
- private update;
2198
- get action(): this;
2199
- get disabled(): boolean;
2200
- get props(): {
2201
- disabled: boolean;
2202
- hidden: boolean;
2203
- loading: boolean;
2487
+ type TUploaderLoadCurrentFunctionMessages = {
2488
+ allowSign: boolean;
2489
+ allowLock: boolean;
2490
+ allowMultiple: boolean;
2491
+ readOnly: boolean;
2492
+ };
2493
+ type TSaveDroppedFilesConf = {
2494
+ langId?: number;
2495
+ strictMode?: boolean;
2496
+ translatingFile?: TUploaderFileInfo;
2497
+ shouldReset?: boolean;
2498
+ };
2499
+ type TAjaxUploadFileStatus = TApiaLoad<TApiaFunction<{
2500
+ message: {
2501
+ label: string;
2502
+ name: string;
2503
+ }[];
2504
+ }>>;
2505
+ type TProcessDroppedFiles = TApiaLoad<TApiaFunction<{
2506
+ principal: {
2507
+ docInfo: TDocInfo | TDocInfo[];
2508
+ docTypes: {
2509
+ 'data-free': boolean;
2510
+ docTypeExtensions: string;
2511
+ docTypeId: string;
2512
+ docTypeMaxSize: number;
2513
+ docTypeName: string;
2514
+ };
2515
+ elemInfo: {
2516
+ elemId: string;
2517
+ elemType: string;
2518
+ };
2204
2519
  };
2205
- get label(): string;
2206
- get title(): string;
2207
- get variant(): string;
2208
- set title(title: string);
2209
- set variant(variant: string);
2210
- disable(): void;
2211
- enable(): void;
2212
- hide(): void;
2213
- show(): void;
2214
- }
2520
+ }, false>>;
2521
+ type TDocInfo = {
2522
+ docInfoName: string;
2523
+ docInfoSize: string;
2524
+ docInfoTmpId: string;
2525
+ docInfoType: string;
2526
+ };
2527
+ type TConfirmDropModal = TApiaLoad<TApiaFunction<{
2528
+ general: TFileUploaded | TFileUploaded[];
2529
+ fromForm: {
2530
+ fromForm: {
2531
+ fromForm: boolean;
2532
+ }[];
2533
+ };
2534
+ }, false>>;
2535
+ type TApiaDocumentDefinition = {
2536
+ docDesc: string;
2537
+ docTypeLabel: string;
2538
+ docId: string;
2539
+ prefix: string;
2540
+ docSize: string;
2541
+ docDate: string;
2542
+ docDwnExternal: string;
2543
+ docExpDate: string;
2544
+ docFolder: string;
2545
+ docFolderPath: string;
2546
+ docUsu: string;
2547
+ docAllPoolPerm: 'M' | 'R' | '';
2548
+ docName: string;
2549
+ docTypeId: string;
2550
+ locked: boolean;
2551
+ downloadDocId: string;
2552
+ };
2553
+ type TUploaderLoadCurrentFunction = {
2554
+ general?: TFileUploaded | TFileUploaded[];
2555
+ messages: {
2556
+ message: {
2557
+ name: keyof TUploaderLoadCurrentFunctionMessages;
2558
+ label: boolean;
2559
+ } | {
2560
+ name: keyof TUploaderLoadCurrentFunctionMessages;
2561
+ label: boolean;
2562
+ }[];
2563
+ };
2564
+ };
2565
+ type TDocumentInformation = TApiaLoad<TApiaFunction<{
2566
+ data: {
2567
+ onClose: string;
2568
+ general: TApiaDocumentDefinition;
2569
+ permissions: {
2570
+ pool: TDocumentPermission | TDocumentPermission[];
2571
+ user: TDocumentPermission | TDocumentPermission[];
2572
+ };
2573
+ versions: {
2574
+ version: TDocumentVersion | TDocumentVersion[];
2575
+ };
2576
+ };
2577
+ currentUsrPems: {
2578
+ usrCanModify: boolean;
2579
+ };
2580
+ metadatas: {
2581
+ metadata: TDocumentMetadata | TDocumentMetadata[];
2582
+ };
2583
+ docDownHistory: {
2584
+ docHistory: TDocumentDownloadHistory | TDocumentDownloadHistory[];
2585
+ };
2586
+ }, false>>;
2587
+ type TDocumentPermission = {
2588
+ id: string;
2589
+ name: string;
2590
+ permType: 'R' | 'M';
2591
+ };
2592
+ type TDocumentDownloadHistory = {
2593
+ hisDwn: string;
2594
+ hisUsr: string;
2595
+ hisVer: string;
2596
+ };
2597
+ type TDocumentVersion = {
2598
+ verUser: string;
2599
+ verNumber: string;
2600
+ verDate: string;
2601
+ };
2602
+ type TRequireOnlyOne<T, Keys extends keyof T = keyof T> = Pick<T, Exclude<keyof T, Keys>> & {
2603
+ [K in Keys]-?: Required<Pick<T, K>> & Partial<Record<Exclude<Keys, K>, undefined>>;
2604
+ }[Keys];
2215
2605
 
2216
- declare global {
2217
- interface Window {
2218
- lastModalReturn: string[];
2219
- }
2220
- }
2221
- declare class ApiaFunctions implements IApiaFunctions {
2606
+ declare class FormsUploader extends UploaderApi {
2222
2607
  execution: Execution;
2223
- constructor(execution: Execution);
2224
- toJSNumber(_value: string): number | string;
2225
- toApiaNumber(_value: number): number | string;
2226
- openTab(_title: string, _url: string): void;
2227
- showMessage(_text: string): void;
2228
- showConfirm(_text: string, _title: string, _callbackFn: (win: boolean) => unknown): void;
2229
- getFormByType(frmName: string, frmType: TFrmParent): IApiaForm | null;
2230
- actionButton(id: string | number): ButtonsAction | undefined;
2231
- admEntity(entName: string, entNum?: number, parameters?: string, width?: number, height?: number): void;
2232
- clearMessages(): void;
2233
- clickActionButton(button: number): void;
2234
- disableActionButton(id: string | number): void;
2235
- disableOptionButton(id: string | number): void;
2236
- enableActionButton(id: string | number): void;
2237
- enableOptionButton(id: string | number): void;
2238
- getAllForms(): IApiaForm[];
2239
- getAllFormsByType(type: 'P' | 'E'): IApiaForm[];
2240
- getAttField(attType: 'P' | 'E', attId: string): IApiaField | IApiaField[] | undefined;
2241
- getButtonAction(id: number | string): "sbtEjeDoc" | "btnClose" | "lblExeDelegar" | "btnCon" | "btnSig" | "btnStaPri" | "btnAnt" | "btnEjeLib" | "btnGua" | "lblShareMsg";
2242
- getCurrentLanguageCode(): string | null;
2243
- getCurrentProcessName(): string | null;
2244
- getCurrentStep(): number | null;
2245
- getCurrentTaskName(): string | null;
2246
- getEntityForm(frmName: string): IApiaForm | null;
2247
- getForm(frmName: string, frmType?: string): IApiaForm | null;
2248
- getLastModalReturn(): string[];
2249
- getModalReturn(): string[];
2250
- getModalSelectedRow(): string[];
2251
- getModalShowValue(): string;
2252
- getModalValue(): string;
2253
- getProcessForm(frmName: string): IApiaForm | null;
2254
- getRootPath(): string | null;
2255
- hideActionButton(id: string | number): void;
2256
- hideOptionButton(id: string | number): void;
2257
- saveTask(): void;
2258
- setLastModalReturn(value: string[]): void;
2259
- setStepTitle(stepNumber: number, stepTitle: string): void;
2260
- showActionButton(id: string | number): void;
2261
- showOptionButton(id: string | number): void;
2262
- viewAdmEntity(entName: string, entNum?: number): void;
2608
+ type: 'E' | 'P';
2609
+ modalConfig: TModalConfig;
2610
+ field: File$1;
2611
+ constructor(execution: Execution, type: 'E' | 'P', modalConfig: TModalConfig, field: File$1);
2612
+ isEditionMode: boolean | undefined;
2613
+ index(): number;
2614
+ elemId(): string;
2615
+ protected filterByFilesAmountLimit(files: File[]): File[];
2616
+ protected getFormParameters(): {
2617
+ frmId: string;
2618
+ frmParent: TFrmParent;
2619
+ attId: string;
2620
+ index: number;
2621
+ editionMode: boolean | undefined;
2622
+ prefix: TFrmParent;
2623
+ };
2624
+ evaluateDeleteDocumentResult(result: undefined | {
2625
+ success: boolean;
2626
+ }): boolean;
2627
+ getAjaxUrl(): string;
2628
+ getAllowedTypesData(): {
2629
+ postData: {
2630
+ docTypeId: string | undefined;
2631
+ forDropElem: boolean;
2632
+ };
2633
+ queryData: {
2634
+ frmId: string;
2635
+ frmParent: TFrmParent;
2636
+ attId: string;
2637
+ index: number;
2638
+ editionMode: boolean | undefined;
2639
+ prefix: TFrmParent;
2640
+ elemType: string;
2641
+ fromFormElem: boolean;
2642
+ docTypeId: string | undefined;
2643
+ frmOut: boolean;
2644
+ };
2645
+ };
2646
+ getAjaxUploadFileStatusParameters: (defaultParameters: Record<string, unknown>) => Record<string, unknown>;
2647
+ getAjaxUploadStartParameters: ({ useDocTypePermitted, docTypePermittedObjType, docTypePermittedObjId, ...defaultParameters }: Record<string, unknown>) => Record<string, unknown>;
2648
+ getCheckLockDocumentParameters: ({ prefix, ...parameters }: Record<string, unknown>) => {
2649
+ frmId: string;
2650
+ frmParent: TFrmParent;
2651
+ attId: string;
2652
+ index: number;
2653
+ editionMode: boolean | undefined;
2654
+ prefix: TFrmParent;
2655
+ };
2656
+ getCheckSignatureParameters: (parameters: Record<string, unknown>) => {
2657
+ frmId: string;
2658
+ frmParent: TFrmParent;
2659
+ };
2660
+ getClearTempFilesParameters: ({ elemType, ...rest }: Record<string, unknown>) => {
2661
+ frmParent: TFrmParent;
2662
+ frmId: string;
2663
+ attId: string;
2664
+ index: number;
2665
+ };
2666
+ getConfirmDropModalParameters: (defaultParameters: Record<string, unknown>) => Record<string, unknown>;
2667
+ getConfirmDropModalPostdata: ({ pe, ...parameters }: Record<string, unknown>) => Record<string, unknown>;
2668
+ getDeleteDocumentParameters: ({ prefix, isAjax, ...currentParameters }: Record<string, unknown>) => {
2669
+ frmId: string;
2670
+ frmParent: TFrmParent;
2671
+ attId: string;
2672
+ index: number;
2673
+ editionMode: boolean | undefined;
2674
+ };
2675
+ getDocumentInfoParameters: (parameters: Record<string, unknown>) => {
2676
+ ajaxUrl: string;
2677
+ };
2678
+ getEditDocumentParameters: ({ action, docId }: Record<string, unknown>) => {
2679
+ docId: unknown;
2680
+ ajaxUrl: string;
2681
+ frmId: string;
2682
+ frmParent: TFrmParent;
2683
+ attId: string;
2684
+ index: number;
2685
+ action: unknown;
2686
+ };
2687
+ getLoadFilesForFolderParameters: () => Record<string, unknown>;
2688
+ getLoadFileSystemStructureTree: () => {
2689
+ useDocTypePermitted: boolean;
2690
+ docTypeForcedId: string | undefined;
2691
+ };
2692
+ getLockDocumentParameters: ({ prefix, isAjax, ...currentParameters }: Record<string, unknown>) => {
2693
+ frmId: string;
2694
+ frmParent: TFrmParent;
2695
+ attId: string;
2696
+ index: number;
2697
+ editionMode: boolean | undefined;
2698
+ };
2699
+ getMarkFileToSignParameters: ({ docId, prefix, ...defaultParameters }: Record<string, unknown>) => {
2700
+ frmId: string;
2701
+ frmParent: TFrmParent;
2702
+ attId: string;
2703
+ index: number;
2704
+ editionMode: boolean | undefined;
2705
+ prefix: TFrmParent;
2706
+ action: string;
2707
+ fldId: string;
2708
+ };
2709
+ getProcessDroppedFilesParameters: (defaultParameters: Record<string, unknown>) => Record<string, unknown>;
2710
+ getProcessDroppedFilesPostdata: ({ useDocTypePermitted, docTypePermittedObjId, docTypePermittedObjType, ...parameters }: Record<string, unknown>) => Record<string, unknown>;
2711
+ getReloadMetadataParameters: (defaultParameters: Record<string, unknown>) => Record<string, unknown>;
2712
+ getSaveDroppedFilesParameters: (defaultParameters: Record<string, unknown>) => Record<string, unknown>;
2713
+ downloadDocument(fileId: string, version?: string): Promise<void>;
2714
+ loadCurrentDocuments(): Promise<void>;
2715
+ parseFileDefinition: (file: TFileUploaded) => TUploaderFileInfo;
2716
+ saveDroppedFiles(unprocessedFiles: File[], conf?: TSaveDroppedFilesConf | undefined): Promise<boolean>;
2263
2717
  }
2264
2718
 
2265
- declare class ActionsController {
2266
- static CONFIRM: number;
2267
- static NEXT: number;
2268
- static PREVIOUS: number;
2269
- static SIGN: number;
2270
- static SAVE: number;
2271
- static RELEASE: number;
2272
- static DELEGATE: number;
2273
- static SHARE: number;
2274
- static PRINT: number;
2275
- static VIEW_DOCS: number;
2276
- static CLOSE: number;
2277
- private static _instance;
2278
- static get instance(): ActionsController;
2279
- private buttons;
2280
- addButton(button: IButton): void;
2281
- getButton(id: TActionButtons): ButtonsAction | undefined;
2719
+ declare class Process {
2720
+ execution: Execution;
2721
+ state: TProcess | null;
2722
+ uploader: UploaderApi;
2723
+ constructor(execution: Execution);
2724
+ get name(): string | undefined;
2725
+ private hasInited;
2726
+ init(): Promise<void>;
2727
+ getConfirmParams(): {
2728
+ cmbProPri: string | undefined;
2729
+ selCal: string | undefined;
2730
+ };
2731
+ setPriority(newPriority: string): void;
2282
2732
  }
2283
2733
 
2284
- declare class ApiaForm implements IApiaForm {
2734
+ declare class Task {
2285
2735
  #private;
2286
- private execution;
2287
- constructor(execution: Execution, form: Form);
2288
- getFrmParent(): string;
2289
- getFrmId(): string | null;
2290
- getFormName(): string;
2291
- getFormTitle(): string;
2292
- openForm(): void;
2293
- closeForm(): void;
2294
- getProperty<K extends keyof TApiaFormProperties>(name: K): TApiaFormProperties[K];
2295
- setProperty<K extends keyof TApiaFormProperties>(name: K, value: TApiaFormProperties[K]): void;
2296
- getCustomComponent(attName: string): CustomComponent | undefined;
2297
- getField(fld: string | number, index?: number): IApiaField | undefined;
2298
- getFieldById(fldId: string): IApiaField<TApiaFieldCommonProperties> | null | undefined;
2299
- getFieldColumn(name: string): IApiaField[];
2300
- getAllFields(): IApiaField[];
2301
- clearForm(clearReadonlyFields: boolean, deleteGridsRows: boolean): void;
2736
+ constructor(task: any);
2737
+ setPriority(newPriority: string): void;
2738
+ get name(): string;
2302
2739
  }
2303
2740
 
2304
- declare abstract class ApiaField<Props extends TApiaFieldCommonProperties = TApiaFieldCommonProperties> implements IApiaField<Props> {
2305
- #private;
2741
+ type TEntity = {
2742
+ title: string;
2743
+ readOnly: boolean;
2744
+ separator: string;
2745
+ associations: Associations[];
2746
+ date: {
2747
+ label: string;
2748
+ toolTip: string;
2749
+ value: string;
2750
+ };
2751
+ entityType: {
2752
+ label: string;
2753
+ toolTip: string;
2754
+ value: string;
2755
+ };
2756
+ identifier: {
2757
+ label: string;
2758
+ toolTip: string;
2759
+ value?: string;
2760
+ prefix?: {
2761
+ name: string;
2762
+ type: 'custom' | 'fixed' | 'none';
2763
+ label?: string;
2764
+ toolTip?: string;
2765
+ value?: string;
2766
+ };
2767
+ body: {
2768
+ type: 'autogenerated' | 'sameAsProcess';
2769
+ label: string;
2770
+ name?: string;
2771
+ toolTip?: string;
2772
+ value?: string;
2773
+ required?: false;
2774
+ } | {
2775
+ label: string;
2776
+ toolTip?: string;
2777
+ value?: string;
2778
+ type: 'custom';
2779
+ required: boolean;
2780
+ name: string;
2781
+ };
2782
+ suffix?: {
2783
+ name: string;
2784
+ type: 'custom' | 'fixed' | 'none';
2785
+ toolTip?: string;
2786
+ label?: string;
2787
+ value?: string;
2788
+ };
2789
+ };
2790
+ image: {
2791
+ label: string;
2792
+ toolTip: string;
2793
+ file: File | null;
2794
+ };
2795
+ status: {
2796
+ name: string;
2797
+ label: string;
2798
+ toolTip: string;
2799
+ type: 'fixex' | 'select' | 'none';
2800
+ value?: string;
2801
+ disabled?: boolean;
2802
+ options: {
2803
+ label: string;
2804
+ value: string;
2805
+ selected: boolean;
2806
+ }[];
2807
+ };
2808
+ user: {
2809
+ label: string;
2810
+ name: string;
2811
+ toolTip: string;
2812
+ };
2813
+ categories: TCategory[] | [];
2814
+ visibilities: PoolId[];
2815
+ };
2816
+ type TCategory = {
2817
+ checked: boolean;
2818
+ envId: string;
2819
+ id: string;
2820
+ idFather: string;
2821
+ name: string;
2822
+ };
2823
+ type PoolId = {
2824
+ poolId: string;
2825
+ poolName: string;
2826
+ canUpdate: boolean;
2827
+ };
2828
+ type Associations = {
2829
+ asocName: string;
2830
+ asocId: string;
2831
+ asocRelName: string;
2832
+ };
2833
+
2834
+ declare class Entity {
2306
2835
  execution: Execution;
2307
- constructor(execution: Execution, field: Field<Props>);
2308
- get fldType(): "button" | "check" | "file" | "hidden" | "image" | "input" | "href" | "multiple" | "radio" | "select" | "label" | "area" | "title" | "editor" | "grid" | "password" | "captcha" | "tree";
2309
- get fldId(): string;
2310
- get form(): ApiaForm;
2311
- get index(): number;
2312
- setProperty<K extends keyof Props>(name: K, value: Props[K]): void;
2313
- getProperty<K extends keyof Props>(name: K): Props[K];
2314
- setFocus(): IApiaField | null;
2315
- isInGrid(): boolean;
2836
+ state: TEntity | null;
2837
+ uploader: UploaderApi;
2838
+ controller: TableController;
2839
+ constructor(execution: Execution);
2840
+ get name(): string | undefined;
2841
+ private hasInited;
2842
+ init(): Promise<void>;
2843
+ getConfirmParams(): any;
2844
+ loadCategories: () => Promise<void>;
2845
+ loadPools: () => Promise<void>;
2846
+ loadAssociations: () => Promise<void>;
2847
+ private parseRows;
2848
+ deleteRow(): void;
2849
+ addRow(): void;
2316
2850
  }
2317
2851
 
2318
- interface TTextFieldProperties extends TApiaFieldCommonProperties {
2319
- value?: string;
2320
- }
2321
- interface IButtonField extends IApiaField {
2322
- fireClickEvent(): void;
2323
- getValue(): string | null;
2324
- }
2325
- declare class ButtonField extends ApiaField<TTextFieldProperties> implements IButtonField {
2326
- #private;
2327
- constructor(execution: Execution, field: Button);
2328
- fireClickEvent(): void;
2329
- getValue(): string | null;
2330
- clearValue(): void;
2331
- setValue(value: string): void;
2332
- }
2852
+ type TObservations = {
2853
+ observations: TObservation[] | [];
2854
+ newObservation: {
2855
+ commentValue: string;
2856
+ chkAddAlert?: boolean;
2857
+ chkAddAllAlert?: boolean;
2858
+ chkRemAlert?: boolean;
2859
+ } | null;
2860
+ };
2861
+ type TObservation = {
2862
+ name: string;
2863
+ date: string;
2864
+ userTitle: string;
2865
+ groupTitle: string;
2866
+ taskTitle: string;
2867
+ userLabel: string;
2868
+ groupLabel: string;
2869
+ taskLabel: string;
2870
+ checked?: boolean;
2871
+ disabled?: boolean;
2872
+ marked?: boolean;
2873
+ comment: string;
2874
+ };
2333
2875
 
2334
- declare class ApiaAttribute {
2335
- #private;
2336
- constructor(attribute: Attribute);
2337
- get attLabel(): string;
2338
- get name(): string;
2339
- get id(): string;
2340
- get valueType(): TApiaFieldValueType;
2341
- }
2342
- declare class ApiaFieldWithAttribute<T = string | boolean> extends ApiaField {
2343
- #private;
2876
+ declare class Observations {
2344
2877
  execution: Execution;
2345
- constructor(execution: Execution, field: FieldWithAttribute);
2346
- get attribute(): ApiaAttribute;
2347
- clearValue(): void;
2348
- getValue(): any;
2349
- setValue(v: T): void;
2350
- getLabel(): string | null | void;
2351
- getProperty<K extends keyof TApiaFieldWithAttributeProperties>(name: K): TApiaFieldWithAttributeProperties[K];
2878
+ state: TObservations;
2879
+ constructor(execution: Execution);
2880
+ private hasInited;
2881
+ init(): Promise<void>;
2882
+ getConfirmParams(): {
2883
+ txtComment: string | undefined;
2884
+ chkAddAlert: string | undefined;
2885
+ chkAddAllAlert: string | undefined;
2886
+ chkRemAlert: string | undefined;
2887
+ };
2888
+ setPriority(newPriority: string): void;
2889
+ }
2890
+
2891
+ type ConfirmStep = 'CHECK_LOCK' | 'CONFIRM' | 'CHECK_SIGN' | 'CHECK_WIZARD' | 'SIGN';
2892
+ type Status = {
2893
+ step?: ConfirmStep;
2894
+ error?: string;
2895
+ finishedWithError?: boolean;
2896
+ };
2897
+ declare abstract class FlowModal<T extends {
2898
+ confirmed?: boolean;
2899
+ }> {
2900
+ abstract confirm(result: T): Promise<Status | FlowModal<any>>;
2352
2901
  }
2353
2902
 
2354
- type TEditorField = IApiaField;
2355
- declare class EditorField extends ApiaFieldWithAttribute implements TEditorField {
2903
+ declare enum ExecutionState {
2904
+ RUNNING = 0,
2905
+ LOADING = 1,
2906
+ FINISHED = 2,
2907
+ RENDERING = 3,
2908
+ CONFIRMING = 4,
2909
+ FINISHED_WITH_ERROR = 5
2356
2910
  }
2911
+ type TOnClose = 'clearEvalPath' | 'confirmOkOnClose' | 'confirmOkOnCloseSplash' | 'confirmOkOnSaveSplash' | 'releaseOkOnClose' | null;
2912
+ type TErrMessage = {
2913
+ message: {
2914
+ text: string;
2915
+ label?: string;
2916
+ };
2917
+ };
2918
+ type TFetchTaskActionResponse = {
2919
+ onClose?: TOnClose;
2920
+ sysMessages?: TErrMessage;
2921
+ sysExceptions?: TErrMessage;
2922
+ type?: string;
2923
+ actions?: {
2924
+ action: {
2925
+ param: string[];
2926
+ toDo: string;
2927
+ };
2928
+ };
2929
+ load?: {
2930
+ canClose: boolean;
2931
+ type: string;
2932
+ text: {
2933
+ label: string;
2934
+ closeAll: boolean;
2935
+ addClass?: string;
2936
+ title?: string;
2937
+ };
2938
+ };
2939
+ text?: {
2940
+ title?: string;
2941
+ label?: string;
2942
+ };
2943
+ };
2357
2944
 
2358
- type TOptionsMap$2 = Map<string, PossibleValue>;
2359
- type TOptionsAsArray = PossibleValue[];
2360
- declare class SelectField extends ApiaFieldWithAttribute<string | number | (string | number)[]> {
2361
- #private;
2362
- constructor(execution: Execution, field: Select);
2363
- getOptions(asObject: boolean): TOptionsMap$2 | TOptionsAsArray | null;
2364
- addOption(optionValue: string | number, showValue: string, allowRepeatedValue: boolean): void;
2365
- setOptions(optionsArray: PossibleValue[]): void;
2366
- removeOption(optionValue: string | number): void;
2367
- getSelectedOption(asObject: boolean): TOptionsMap$2 | PossibleValue[] | null;
2368
- getSelectedText(): string | null;
2369
- clearOptions(): void;
2945
+ type TCheckWizardResponse = {
2946
+ url: string;
2947
+ };
2948
+ type TFetchConfirmPathResponse = {
2949
+ onClose?: string;
2950
+ sysMessages?: {
2951
+ message?: {
2952
+ text: string;
2953
+ };
2954
+ };
2955
+ pathSelection?: boolean | null;
2956
+ groupSelection?: boolean | null;
2957
+ load?: TApiaLoadForm & {
2958
+ type: 'form' | 'text' | 'table' | 'function';
2959
+ canClose: boolean;
2960
+ text?: {
2961
+ closeAll: string;
2962
+ title: string;
2963
+ addClass: string;
2964
+ label: string;
2965
+ content?: string;
2966
+ };
2967
+ };
2968
+ actions?: {
2969
+ action: {
2970
+ toDo: 'functionTimedCall';
2971
+ param: [number, string];
2972
+ };
2973
+ };
2974
+ };
2975
+ type TItemTreeObj = {
2976
+ id: string;
2977
+ name: string;
2978
+ level: number;
2979
+ value: boolean;
2980
+ type: TPathType;
2981
+ isOn: boolean;
2982
+ };
2983
+ type TPathType = 'OR' | 'XOR' | 'AND';
2984
+
2985
+ declare class ShowPathSelection extends FlowModal<{
2986
+ confirmed: boolean;
2987
+ path: string;
2988
+ }> {
2989
+ fetchResult: TApiaLoadForm['form'];
2990
+ confirm: (result: {
2991
+ confirmed: boolean;
2992
+ path: string;
2993
+ }) => Promise<Status | FlowModal<any>>;
2994
+ state: {
2995
+ disabledParents: TItemTreeObj | TItemTreeObj[] | null;
2996
+ groupSelectionObj: TFetchConfirmPathResponse | null;
2997
+ };
2998
+ constructor(fetchResult: TApiaLoadForm['form'], confirm: (result: {
2999
+ confirmed: boolean;
3000
+ path: string;
3001
+ }) => Promise<Status | FlowModal<any>>);
3002
+ setDisabledParent(treeItem: TItemTreeObj): void;
3003
+ clearPaths(): void;
3004
+ showGroupsSelection(fetchConfirmPathResponse: TFetchConfirmPathResponse): void;
3005
+ updateDisabledList(itemObj: TItemTreeObj, itemArr: TItemTreeObj[]): TItemTreeObj[];
2370
3006
  }
2371
3007
 
2372
- declare class InputField extends ApiaFieldWithAttribute {
2373
- #private;
2374
- constructor(execution: Execution, field: Input);
2375
- getObjectValue(): number | string | boolean | null;
2376
- setValue(v: string): void;
3008
+ declare class ShowPoolSelection extends FlowModal<{
3009
+ confirmed: boolean;
3010
+ group: string;
3011
+ }> {
3012
+ fetchResult: TApiaLoadForm['form'];
3013
+ confirm: (result: {
3014
+ confirmed: boolean;
3015
+ group: string;
3016
+ }) => Promise<Status>;
3017
+ constructor(fetchResult: TApiaLoadForm['form'], confirm: (result: {
3018
+ confirmed: boolean;
3019
+ group: string;
3020
+ }) => Promise<Status>);
2377
3021
  }
2378
3022
 
2379
- declare class TreeField extends ApiaFieldWithAttribute<string | number | (string | number)[]> {
2380
- #private;
2381
- constructor(execution: Execution, field: Tree);
2382
- setValue(v: string | number | (string | number)[]): void;
3023
+ declare class ShowSignSelection extends FlowModal<{
3024
+ confirmed: boolean;
3025
+ signed: boolean;
3026
+ }> {
3027
+ fetchResult: any;
3028
+ confirm: (result: {
3029
+ confirmed: boolean;
3030
+ signed: boolean;
3031
+ }) => Promise<Status>;
3032
+ constructor(fetchResult: any, confirm: (result: {
3033
+ confirmed: boolean;
3034
+ signed: boolean;
3035
+ }) => Promise<Status>);
2383
3036
  }
2384
3037
 
2385
- declare class CheckField extends ApiaFieldWithAttribute {
2386
- clearValue(): void;
2387
- setValue(value: string | boolean | number): void;
3038
+ declare class ShowConfirmMessage extends FlowModal<{
3039
+ confirmed: boolean;
3040
+ }> {
3041
+ fetchResult: any;
3042
+ confirm: (result: {
3043
+ confirmed: boolean;
3044
+ }) => Promise<Status>;
3045
+ constructor(fetchResult: any, confirm: (result: {
3046
+ confirmed: boolean;
3047
+ }) => Promise<Status>);
2388
3048
  }
2389
3049
 
2390
- type TOptionsMap$1 = Map<string, PossibleValue>;
2391
- declare class RadioField extends ApiaFieldWithAttribute {
2392
- #private;
2393
- constructor(execution: Execution, field: Radio);
2394
- getOptions(asObject: boolean): TOptionsMap$1 | PossibleValue[] | null;
2395
- clearOptions(): void | null;
2396
- addOption(radioValue: string | number, showValue: string, allowRepeatedValue: boolean): void;
2397
- setOptions(options: PossibleValue[]): void;
2398
- removeOption(radioValue: string | number): void;
2399
- getSelectedOption(asObject: boolean): TOptionsMap$1 | PossibleValue | null;
2400
- getSelectedText(): string | undefined | null;
3050
+ declare class ShowSign extends FlowModal<{
3051
+ confirmed: boolean;
3052
+ }> {
3053
+ fetchResult: any;
3054
+ confirm: (result: {
3055
+ confirmed: boolean;
3056
+ }) => Promise<Status>;
3057
+ constructor(fetchResult: any, confirm: (result: {
3058
+ confirmed: boolean;
3059
+ }) => Promise<Status>);
3060
+ }
3061
+
3062
+ type TExecutionConfig = {
3063
+ canConfirm: boolean;
3064
+ canGoBack: boolean;
3065
+ canGoForward: boolean;
3066
+ canSave: boolean;
3067
+ canFree: boolean;
3068
+ canDelegate: boolean;
3069
+ canClose: boolean;
3070
+ canShare: boolean;
3071
+ isEntity?: boolean;
3072
+ };
3073
+ type TExecutionEnvironment = {
3074
+ fieldsMapping?: FieldsMapping;
3075
+ window: Window;
3076
+ document: Document;
3077
+ headers: any;
3078
+ properties?: {
3079
+ taskName: string;
3080
+ processName: string;
3081
+ };
3082
+ };
3083
+ declare class Execution extends EventEmitter$1<{
3084
+ flow: 'previous' | 'confirm' | 'next' | 'save' | 'release' | 'share' | 'viewDocs' | 'print' | 'delegate';
3085
+ sendToDesktop: null;
3086
+ hideFormModal: Form;
3087
+ showFormAsModal: Form;
3088
+ }> {
3089
+ environment: TExecutionEnvironment;
3090
+ fieldsMapping: FieldsMapping;
3091
+ private entity;
3092
+ private process;
3093
+ private observations;
3094
+ private executedOnLoadEvents;
3095
+ executionConfig: TExecutionConfig | null;
3096
+ private _steps;
3097
+ private _currentStep;
3098
+ private _stepCount;
3099
+ readonly notifications: Notifications;
3100
+ private lastModalReturn;
3101
+ constructor(environment: TExecutionEnvironment);
3102
+ protected formsById: {
3103
+ E: Map<string, Form>;
3104
+ P: Map<string, Form>;
3105
+ };
3106
+ protected forms: {
3107
+ E: Map<string, Form>;
3108
+ P: Map<string, Form>;
3109
+ };
3110
+ state: {
3111
+ executionState: ExecutionState;
3112
+ locked: number;
3113
+ hasChangedAnything: boolean;
3114
+ };
3115
+ getAllForms(): Form[];
3116
+ private hasInitializedFormsTabs;
3117
+ initializeFormsTabs(frmParent: TFrmParent, cb: () => unknown): void;
3118
+ getFormsByType(type: TFrmParent): Form[];
3119
+ getFormByName(formName: string, frmParent?: TFrmParent): Form | undefined;
3120
+ getFormById(formId: string | number, frmParent?: TFrmParent): Form | undefined;
3121
+ get currentStep(): number;
3122
+ get steps(): {
3123
+ title: string;
3124
+ stepNumber: number;
3125
+ status: "completed" | "pending" | "current";
3126
+ }[];
3127
+ getEntity(): Entity;
3128
+ getProcess(): Process;
3129
+ getObservations(): Observations;
3130
+ getCurrentTask(): Task;
3131
+ private mustRenderForms;
3132
+ get locked(): boolean;
3133
+ lock(): () => void;
3134
+ run(executionConfig: TExecutionConfig): Promise<void>;
3135
+ protected getHiddenForms(): Form[];
3136
+ markFormAsRendered(frmParent: string, frmName: string): void;
3137
+ delegate(): Promise<void>;
3138
+ shareSocial(): Promise<void>;
3139
+ flow: {
3140
+ back: () => void;
3141
+ confirm: () => void;
3142
+ next: () => void;
3143
+ previous: () => void;
3144
+ save: () => void;
3145
+ release: () => void;
3146
+ delegate: () => void;
3147
+ share: () => void;
3148
+ viewDocs: () => void;
3149
+ print: () => void;
3150
+ };
3151
+ sendToDesktop(): void;
3152
+ doBack(): Promise<false | undefined>;
3153
+ doConfirm(status?: Status): Promise<boolean | FlowModal<any> | Field>;
3154
+ doFree(): Promise<TApiaApiAxiosResponse<(TFetchTaskActionResponse & ResponseSysMessages) | null> | null>;
3155
+ doNext(result?: {
3156
+ confirmed: boolean;
3157
+ signed: boolean;
3158
+ }): Promise<boolean | Field<TApiaFieldCommonProperties, TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, {
3159
+ definition: Omit<TApiaFieldBaseDefinition<TApiaFieldCommonProperties>, "properties">;
3160
+ }> | ShowSignSelection | undefined>;
3161
+ doPrint(): Promise<void>;
3162
+ doSave(): Promise<false | TApiaApiAxiosResponse<(TFetchTaskActionResponse & ResponseSysMessages) | null>>;
3163
+ getStepTitle(step: number): {
3164
+ title: string;
3165
+ stepNumber: number;
3166
+ status: "completed" | "pending" | "current";
3167
+ } | undefined;
3168
+ /**
3169
+ * Ends the current session
3170
+ */
3171
+ kill(): void;
3172
+ viewDocs(): Promise<(Record<string, unknown> & ResponseSysMessages) | undefined>;
3173
+ setStepTitle(stepNumber: number, stepTitle: string): void;
3174
+ validate(): Promise<true | Field>;
3175
+ setLastModalReturn(value: string[]): void;
3176
+ getLastModalReturn(): string[];
3177
+ private fireEvents;
2401
3178
  }
2402
3179
 
2403
- type TOptionsMap = Map<string, PossibleValue>;
2404
- declare class MultipleField extends ApiaFieldWithAttribute<string[]> {
2405
- #private;
2406
- constructor(execution: Execution, field: Multiple);
2407
- addOption(optionValue: string | number, showValue: string, allowRepeatedValue: boolean): void;
2408
- setValue(value: string[]): void;
2409
- clearOptions(): void;
2410
- getSelectedOption(asObject: boolean): TOptionsMap | PossibleValue[] | null;
2411
- getOptions(asObject: boolean): TOptionsMap | PossibleValue[] | null;
2412
- setOptions(optionsArray: PossibleValue[]): void;
2413
- removeOption(optionValue: string | number): void;
3180
+ declare global {
3181
+ interface Window {
3182
+ [key: string]: string;
3183
+ }
3184
+ interface Document {
3185
+ headers: any;
3186
+ }
2414
3187
  }
2415
-
2416
- declare class HiddenField extends ApiaField {
3188
+ declare function isJsonResponse(response: AxiosResponse<unknown>): RegExpMatchArray | null;
3189
+ declare function isXmlResponse(response: AxiosResponse<unknown>): RegExpMatchArray | null;
3190
+ declare function isHtmlResponse(response: AxiosResponse<unknown>): RegExpMatchArray | null;
3191
+ declare class InvalidSessionException extends Error {
2417
3192
  }
3193
+ declare const parseSuccessfulResponse: <LoadType extends Record<string, unknown>, DataType = unknown>(execution: Execution, response: AxiosResponse<string>, behaveConfig?: IApiaApiPostConfig<DataType>) => Promise<(ResponseSysMessages & LoadType & {
3194
+ onClose?: string;
3195
+ code?: unknown;
3196
+ load?: LoadType | undefined;
3197
+ }) | ({
3198
+ actions: unknown;
3199
+ onClose: string | undefined;
3200
+ exceptions: {
3201
+ exception: TApiaMessage | TApiaMessage[];
3202
+ } | undefined;
3203
+ sysExceptions: {
3204
+ exception: TApiaMessage | TApiaMessage[];
3205
+ } | undefined;
3206
+ sysMessages: {
3207
+ message: TApiaMessage | TApiaMessage[];
3208
+ } | undefined;
3209
+ } & LoadType) | null>;
3210
+ /**
3211
+ * IMPORTANT!! The ApiaApi is programmed under the slogan that
3212
+ * **should never throw an exception**. **Errors** coming from
3213
+ * connectivity or exceptions on the server **will be handled
3214
+ * automatically** by ApiaApi, using the notification system
3215
+ * of the application. It is possible to determine in what context they should
3216
+ * be thrown those exceptions (global, main, modal) using the
3217
+ * alertsCategory configuration properties **(see errorsHandling.md)**.
3218
+ *
3219
+ * @param url String, the url you want to call
3220
+ * @param config interface IApiaApiRequestConfig<DataType>;
3221
+ *
3222
+ * @throws Nothing
3223
+ *
3224
+ * @example
3225
+ *
3226
+ * ApiaApi.post<ResponseType>('url...', {
3227
+ axiosConfig?: AxiosRequestConfig;
2418
3228
 
2419
- declare class AreaField extends ApiaFieldWithAttribute {
2420
- }
3229
+ // Configuración de postData
3230
+ postData? unknown;
3231
+ postDataTreatement?: 'stringify' | undefined;
2421
3232
 
2422
- interface IImageField extends IApiaField {
2423
- getValue(): null;
2424
- setValue(): null;
2425
- getLabel(): void;
2426
- clearValue(): null;
2427
- }
2428
- declare class ImageField extends ApiaField implements IImageField {
2429
- #private;
2430
- constructor(execution: Execution, field: Image);
2431
- clearValue(): null;
2432
- getLabel(): void;
2433
- getValue(): null;
2434
- setValue(): null;
2435
- }
3233
+ // Configuración de queryString
3234
+ queryData?: string | Record<string, unknown>;
3235
+ stringifyOptions?: QueryString.IStringifyOptions;
2436
3236
 
2437
- interface ILinkField extends IApiaField {
2438
- getLabel(): void;
2439
- }
2440
- declare class LinkField extends ApiaField implements ILinkField {
2441
- #private;
2442
- constructor(execution: Execution, field: Link);
2443
- getLabel(): void;
2444
- }
3237
+ // Response validator,
3238
+ // If it returns true, everything continues correctly
3239
+ // If it returns false, the ApiaApi throws a standard error.
3240
+ // If it returns string, ApiaApi throws the error returned in the string.
3241
+ validateResponse?: (
3242
+ response: AxiosResponse<DataType | null>,
3243
+ ) => boolean | string;
2445
3244
 
2446
- interface ITextField extends IApiaField {
2447
- getLabel(): void;
2448
- }
2449
- declare class TextField extends ApiaField<TTextFieldProperties> implements ITextField {
2450
- #private;
2451
- constructor(execution: Execution, field: Field);
2452
- getLabel(): void;
2453
- setValue(value: string): void;
2454
- }
3245
+ // Configuración de alertas
3246
+ alertsImportance?: TAlertImportance;
2455
3247
 
2456
- declare class GridField extends ApiaField<TApiaGridProperties> {
2457
- #private;
2458
- constructor(execution: Execution, field: Grid);
2459
- addRow(): Promise<IApiaField[]>;
2460
- clearGrid(): void;
2461
- clearPage(): void;
2462
- clearRow(index: number): Promise<void>;
2463
- closeForm(): GridField;
2464
- deleteAllRows(): Promise<void>;
2465
- deleteGrid(): Promise<void>;
2466
- deletePage(): void;
2467
- deleteRow(index: number): Promise<void>;
2468
- editRow(index: number): void;
2469
- getAllColumns(): (IApiaField<TApiaFieldCommonProperties> | null)[][];
2470
- getColumn(fieldName: string): (IApiaField<TApiaFieldCommonProperties> | null)[];
2471
- getCurrentPage(): number;
2472
- getField(fieldName: string, fieldIndex?: number): IApiaField<TApiaFieldCommonProperties> | IApiaField<TApiaFieldCommonProperties>[] | null;
2473
- getPageCount(): number;
2474
- getPageSize(): number;
2475
- getRow(index: number): IApiaField<TApiaFieldCommonProperties>[] | undefined;
2476
- getSelection(): IApiaField[][];
2477
- get id(): string;
2478
- isPaged(): boolean;
2479
- get rowsCount(): number;
2480
- toggleColumnVisibility(fieldName: string, isShown?: boolean): void;
2481
- toggleDeleteButton(index: number, isShown?: boolean): void;
2482
- toggleEditFormButton(rowIndex: number, isShown?: boolean): void;
2483
- }
3248
+ // Configuración de ApiaApiHandler, falta documentar
3249
+ handleLoad?: boolean;
3250
+ eventsHandler?: IEventsHandler;
2484
3251
 
2485
- type TCaptchaField = IApiaField;
2486
- declare class CaptchaField extends ApiaField implements TCaptchaField {
2487
- }
3252
+ // other configuration
3253
+ colors?: TColors;
3254
+ debug?: boolean;
3255
+ }
3256
+ * @returns The type of the return value depends on the type passed when calling the function. If there was an error it returns null.
3257
+ */
3258
+ declare function post<LoadType extends Record<string, unknown> = Record<string, unknown>, DataType = unknown, T = unknown>(execution: Execution, actualUrl: string, behaveConfig?: IApiaApiPostConfig<DataType>): TApiaApiResult<LoadType>;
3259
+ /**
3260
+ * IMPORTANTE!! El ApiaApi está programado bajo la consigna de que
3261
+ * **no debe tirar núnca una excepción**. **Los errores** provenientes
3262
+ * de la conectividad o de excepciones en el servidor **serán manejados
3263
+ * automáticamente** por el ApiaApi utilizando el sistema de notificaciones
3264
+ * de la aplicación. Es posible determinar en qué contexto deben
3265
+ * ser lanzadas esas excepciones (global, main, modal) utilizando las
3266
+ * propiedades de configuración alertsCategory **(ver errorsHandling.md)**.
3267
+ *
3268
+ * @param url String, el url al que se desea llamar
3269
+ * @param config interface IApiaApiRequestConfig<DataType>;
3270
+ *
3271
+ * @throws Nothing
3272
+ *
3273
+ * @example
3274
+ *
3275
+ * ApiaApi.get<TipoDeRespuesta>('url...', {
3276
+ axiosConfig?: AxiosRequestConfig;
2488
3277
 
2489
- declare class FileUploaderField extends ApiaFieldWithAttribute {
2490
- #private;
2491
- constructor(execution: Execution, field: File$1);
2492
- onChange(cb: (newValue: unknown) => unknown): void;
2493
- setValue(): null;
2494
- }
3278
+ // Configuración de queryString
3279
+ queryData?: string | Record<string, unknown>;
3280
+ stringifyOptions?: QueryString.IStringifyOptions;
2495
3281
 
2496
- declare class PasswordField extends ApiaField {
2497
- }
3282
+ // Validador de respuesta,
3283
+ // Si devuelve true, todo sigue correctamente
3284
+ // Si devuelve false, el ApiaApi tira un error estándar.
3285
+ // Si devuelve string, el ApiaApi tira el error devuelto en el string.
3286
+ validateResponse?: (
3287
+ response: AxiosResponse<DataType | null>,
3288
+ ) => boolean | string;
2498
3289
 
2499
- declare class ModalInputField extends ApiaFieldWithAttribute {
2500
- #private;
2501
- constructor(execution: Execution, field: ModalInput);
2502
- getObjectValue(): any | null;
2503
- setValue(v: any): void;
2504
- setValueFromInputWrite(value: string): Promise<void>;
2505
- }
3290
+ // Configuración de alertas
3291
+ alertsImportance?: TAlertImportance;
2506
3292
 
2507
- type TCreateNewField = (execution: Execution, field: Field | FieldWithAttribute | CustomComponent) => IApiaField | null;
3293
+ // Configuración de ApiaApiHandler, falta documentar
3294
+ handleLoad?: boolean;
3295
+ eventsHandler?: IEventsHandler;
2508
3296
 
2509
- declare const createNewField: TCreateNewField;
3297
+ // Otra configuración
3298
+ colors?: TColors;
3299
+ debug?: boolean;
3300
+ }
3301
+ * @returns El tipo del valor devuelto depende del tipo pasado al llamar a la función. Si hubo un error devuelve null
3302
+ */
3303
+ declare function get<LoadType extends Record<string, unknown> = Record<string, unknown>, T = unknown, D = unknown>(execution: Execution, actualUrl: string, behaveConfig?: IApiaApiRequestConfig): TApiaApiResult<LoadType>;
3304
+ type MakeApiaUrlProps = {
3305
+ action?: string;
3306
+ ajaxUrl?: string;
3307
+ queryString?: string;
3308
+ stringifyOptions?: IStringifyOptions;
3309
+ tabId?: string | number;
3310
+ preventAsXmlParameter?: boolean;
3311
+ avoidTabId?: boolean;
3312
+ [key: string]: unknown;
3313
+ };
3314
+ /**
3315
+ * Creates an url based on the general requirements of Apia.
3316
+ * If the ajaxUrl property is not passed, it will use the
3317
+ * getWindow(execution).URL_REQUEST_AJAX. Its use is very simple, just pass the objects you
3318
+ * want to appear in the query string.
3319
+ *
3320
+ * @example makeApiaUrl({
3321
+ * ajaxUrl: 'the.endpoint.you.want',
3322
+ * queryString: 'an=existent&query=string',
3323
+ * action: 'theAction',
3324
+ * anotherProp: 15
3325
+ * })
3326
+ *
3327
+ * @returns the well formed url, in the example, the response url is:
3328
+ * /context/the.endpoint.you.want?an=existent&query=string&anotherProp=15&tabId=...&tokenId=...&action=theAction
3329
+ */
3330
+ declare function makeApiaUrl(execution: Execution, props?: MakeApiaUrlProps): string;
2510
3331
 
2511
3332
  type TFncParams = {
2512
3333
  type: 'V' | 'P' | 'E';
@@ -2569,7 +3390,7 @@ declare class Captcha extends Field<TApiaCaptchaProperties, TApiaCaptchaDefiniti
2569
3390
 
2570
3391
  type CheckboxEvents = 'onClick';
2571
3392
  declare class Checkbox extends FieldWithAttribute<TApiaCheckboxProperties, boolean> {
2572
- fireEvent(eventName: CheckboxEvents): Promise<boolean>;
3393
+ fireEvent(eventName: CheckboxEvents, options?: TFireEventOptions): Promise<boolean>;
2573
3394
  protected getInitialValue({ value, properties, }: TApiaFieldWithAttributeBaseProps<TApiaCheckboxProperties>): Promise<boolean>;
2574
3395
  setValue(newValue: boolean, options?: Partial<{
2575
3396
  comparator: Comparator$1<any>;
@@ -2581,7 +3402,7 @@ declare class Checkbox extends FieldWithAttribute<TApiaCheckboxProperties, boole
2581
3402
 
2582
3403
  type EditorEvents = 'onChange';
2583
3404
  declare class Editor extends TranslatableField<TApiaEditorProperties, string> {
2584
- fireEvent(eventName: EditorEvents): Promise<boolean>;
3405
+ fireEvent(eventName: EditorEvents, options?: TFireEventOptions): Promise<boolean>;
2585
3406
  protected isValidValue(): boolean;
2586
3407
  }
2587
3408
 
@@ -2825,7 +3646,8 @@ declare class Image extends Field<TApiaImageProperties> {
2825
3646
 
2826
3647
  type InputEvents$1 = 'onChange' | 'onModalReturn';
2827
3648
  declare class Input extends TranslatableField<TApiaInputProperties, string, TApiaInputDefinition> {
2828
- fireEvent(eventName: InputEvents$1): Promise<boolean>;
3649
+ private validDate;
3650
+ fireEvent(eventName: InputEvents$1, options?: TFireEventOptions): Promise<boolean>;
2829
3651
  setValue(newValue: string | Date | number, options?: SetValueOptions): Promise<boolean>;
2830
3652
  private validateRegex;
2831
3653
  validate(): Promise<boolean>;
@@ -2865,7 +3687,7 @@ type ModalInputValue = {
2865
3687
  declare class ModalInput extends FieldWithAttribute<TApiaInputProperties, ModalInputValue> {
2866
3688
  isLoading: boolean;
2867
3689
  constructor({ value, ...definition }: TApiaModalInputDefinition);
2868
- fireEvent(eventName: InputEvents): Promise<boolean>;
3690
+ fireEvent(eventName: InputEvents, options?: TFireEventOptions): Promise<boolean>;
2869
3691
  protected hasValue(): boolean;
2870
3692
  setValueFromInputWrite(value: string): Promise<void>;
2871
3693
  setValueFromModalSelection(rowId: string): Promise<void>;
@@ -2894,7 +3716,7 @@ type RadioEvents = 'onPopulate' | 'onChange' | 'onClick';
2894
3716
  declare class Radio extends FieldWithAttribute<TApiaRadioProperties, number | string, TApiaRadioButtonDefinition> {
2895
3717
  constructor({ possibleValue, ...definition }: TApiaRadioButtonDefinition);
2896
3718
  init(form: Form): Promise<void>;
2897
- fireEvent(eventName: RadioEvents): Promise<boolean>;
3719
+ fireEvent(eventName: RadioEvents, options?: TFireEventOptions): Promise<boolean>;
2898
3720
  }
2899
3721
 
2900
3722
  declare class Select extends FieldWithAttribute<TApiaSelectProperties, string, TApiaSelectDefinition> {
@@ -2916,7 +3738,7 @@ declare class Tree extends FieldWithAttribute<TApiaTreeProperties, TTreeValue[],
2916
3738
  private parseTreeValues;
2917
3739
  constructor({ possibleValue, ...props }: TApiaTreeDefinition);
2918
3740
  protected getSynchronizePostConfiguration(value: TTreeValue[]): IApiaApiPostConfig<any>;
2919
- fireEvent(eventName: TreeEvents): Promise<boolean>;
3741
+ fireEvent(eventName: TreeEvents, options?: TFireEventOptions): Promise<boolean>;
2920
3742
  protected hasValue(): boolean;
2921
3743
  setProperty<K extends keyof TApiaTreeProperties>(propName: K, propValue: TApiaTreeProperties[K]): void;
2922
3744
  init(form: Form): Promise<void>;
@@ -2945,23 +3767,16 @@ declare class SchedulerField extends Field<TApiaSchedulerProperties> {
2945
3767
  loadWeek(weekDay: string, schId: string, proId: string, proVerId: string, tskId: string): Promise<(TScheduleResult & ResponseSysMessages) | null>;
2946
3768
  loadInfo(schId: string, weekDay: string, dayNumber: number, hour: string): Promise<_apia_scheduler_controller.TProcesses>;
2947
3769
  markDay(weekDay: string, hour: string, dayNumber: number): Promise<void>;
2948
- get schedController(): Scheduler;
3770
+ get schedController(): Scheduler | undefined;
2949
3771
  }
2950
3772
 
2951
3773
  declare const IProperty: {
2952
- readonly FUNC_LOAD: "onload";
2953
- readonly FUNC_RELOAD: "onreload";
2954
- readonly PROPERTY_FORM_INVISIBLE: "frmInvisible";
2955
3774
  readonly PROPERTY_FORM_HIDDEN: "frmHidden";
3775
+ readonly PROPERTY_FORM_HIGHLIGHT: "frmHighlight";
2956
3776
  readonly PROPERTY_FORM_CLOSED: "prpFrmClosed";
2957
3777
  readonly PROPERTY_FORM_TAB: "frmTab";
2958
- readonly PROPERTY_FORM_HIGHLIGHT: "frmHighlight";
2959
3778
  readonly PROPERTY_FORM_DONT_FIRE: "frmDontFire";
2960
3779
  readonly PROPERTY_FORM_READONLY: "readOnly";
2961
- readonly SIGNABLE_FORM: "signableForm";
2962
- readonly MARKED_TO_SIGN: "markedToSign";
2963
- readonly REQUIRED_SIGN: "requiredSignableForm";
2964
- readonly LANGUAGES: "langs";
2965
3780
  readonly TYPE_INPUT: "input";
2966
3781
  readonly TYPE_SELECT: "select";
2967
3782
  readonly TYPE_RADIO: "radio";
@@ -2980,14 +3795,6 @@ declare const IProperty: {
2980
3795
  readonly TYPE_EDITOR: "editor";
2981
3796
  readonly TYPE_TREE: "tree";
2982
3797
  readonly TYPE_CAPTCHA: "captcha";
2983
- readonly FUNC_CLICK: "onclick";
2984
- readonly FUNC_CHANGE: "onchange";
2985
- readonly FUNC_MODAL_RETURN: "onmodalreturn";
2986
- readonly FUNC_ROW_ADD: "onrowadd";
2987
- readonly FUNC_ROW_DELETE: "onrowdelete";
2988
- readonly FUNC_ROW_SORT: "onrowsort";
2989
- readonly FUNC_COL_SELECT: "oncolselect";
2990
- readonly FIELD_PROPERTIES: "properties";
2991
3798
  readonly PROPERTY_NAME: "name";
2992
3799
  readonly PROPERTY_SIZE: "size";
2993
3800
  readonly PROPERTY_READONLY: "readonly";
@@ -3252,5 +4059,5 @@ declare function getLabel(execution: Execution, label: string, replacers?: Parti
3252
4059
 
3253
4060
  declare function parseFakeJSON<T extends Record<string, unknown>>(str: string): T;
3254
4061
 
3255
- 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 };
4062
+ 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 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 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 };
3256
4063
  //# sourceMappingURL=index.d.ts.map