@sankhyalabs/ezui 0.0.0-bugfix-dev-KB-08202.0

package/dist/types/components/ez-grid/controller/EzGridController.d.ts

@@ -0,0 +1,287 @@
+import { DataUnit, Filter } from '@sankhyalabs/core';
+import { Components } from '../../../components';
+import FilterCollumn = Components.FilterColumn;
+import { IRecordValidator } from '../../../utils/form/interfaces';
+import { GridApi } from 'ag-grid-community';
+/**
+ * O intuito desta abstração, é isolar o componente EzGrid de uma implementação
+ * específica, permitindo que usemos componentes de terceiros sem um acoplamento
+ * direto.
+ * Isso permitirá que no futuro possamos trocar a implementação usada sem prejuízo
+ * às aplicações que o usam.
+ *
+ * IMPORTANTE: Como consumidores de API de terceiros precisamos manter toda e qualquer
+ * funcionalidade abstrata, ou seja, se o componente usa determinada funcionalidade da
+ * implementação de referência essa funcionalidade deve estar COMPLETAMENTE abstraída
+ * pelo controller, sob pena de inviabilizar a troca da implementação usada.
+ */
+export default interface EzGridController {
+  /**
+   * Chamado pelo EzGrid para criar os elementos DOM da grade.
+   * @param container - O elemento que será usado como host para construir a grade.
+   * @param options - A contextualização dessa instância de grade.
+  */
+  initDatagrid(container: HTMLElement, options: EzGridOptions): void;
+  /**
+   * Chamado pelo EzGrid para retornar a api de manipulação da grade.
+   */
+  getGridApi(): GridApi;
+  /**
+   * Método responsável por receber a definição das colunas.
+   * @param cols - Array contendo a definição de todas as colunas.
+   * para controlar a seleção.
+   */
+  setColumnsDef(cols: Array<EzGridColumn>): void;
+  /**
+  * Retorna a definição das colunas.
+  * @return - Array contendo as definições de cada coluna.
+  */
+  getColumnsDef(): Array<EzGridColumn>;
+  /**
+   * Recebe o estado das colunas. Geralmente o estado pode ser persistido separadamete
+   * da definição básica da coluna. Nesse caso esse método o recebe e aplica.
+   * @param state - Array contendo as informações de estado de cada coluna.
+   */
+  setColumnsState(state: Array<EzGridColumnConfig>): void;
+  /**
+   * Retorna o estado das colunas.
+   * @return - Array contendo as informações de estado de cada coluna.
+   */
+  getColumnsState(): Array<EzGridColumn>;
+  /**
+   * Seleção de linhas.
+   * @returns Retorna um array com a(s) linha(s) selecionada(s).
+   */
+  getSelection(): Array<any>;
+  /**
+   * Adiciona um item de menu a ser colocado no cabeçalho das colunas.
+   * @param item - A definição do item que deve ser inserido no menu.
+   */
+  addColumnMenuItem(item: EzGridColumnMenuItemDef): void;
+  /**
+   * Método responsável por atribuir o array de linhas da grade.
+   * @param data - Array contendo objetos json que representam
+   * as linhas da grade (os dados propriamente ditos).
+   */
+  setData(data: Array<any>): void;
+  /**
+   * Método responsável por adicionar linhas novas
+   */
+  addRows(rows?: Array<any>): void;
+  /**
+   * Método responsável por atualzar linhas da grid
+   */
+  updateRows(rows?: Array<any>): void;
+  /**
+  * Método responsável por remover linhas da grade
+  */
+  removeRows(rows?: Array<any>): void;
+  /**
+   * Método responsável por selecionar linhas
+   */
+  selectRows(rowIds: Array<string>, quietly?: boolean): void;
+  /**
+   * Método responsável por selecionar todas as de uma vez.
+   */
+  selectAll(quietly?: boolean): void;
+  /**
+  * Método responsável por alterar o valores nos registros
+  */
+  changeValues(changes: any, rowIds?: Array<string>): void;
+  /**
+   * Método responsável por atualizar as linhas da grade
+   */
+  refresh(): void;
+  /**
+   * Adiciona um filtro rápido na grid e faz o refresh.
+   */
+  quickFilter(term: string): void;
+  /**
+   * Foca a ultima linha da grade, usado durante a troca de página
+   */
+  setFocusLastRow(): void;
+  /**
+   * Foca a primeira linha da grade, usado durante a troca de página
+   */
+  setFocusFirstRow(): void;
+  /**
+   * Método responsável por retornar a configuração da grade.
+   */
+  getGridConfig(): Array<EzGridColumnConfig>;
+  configFilterColumn(filterColumn: FilterCollumn): any;
+  getFilter(): Array<Filter> | undefined;
+}
+/**
+ * Carrega as informações necessárias para contextualizar corretamente a instância.
+ */
+export interface EzGridOptions {
+  /**
+   * Callback a ser chamado quando algum atributo das colunas é alterado.
+   */
+  onColumnStateChange: Function;
+  /**
+   * Callback a ser chamado quando as linhas selecionadas mudam.
+   */
+  onSelectionChange: Function;
+  /**
+  * Callback para reagir à paginação
+  */
+  onPaginationChange: Function;
+  /**
+  * Callback para reagir ao clique duplo na linha
+  */
+  onDoubleClick: Function;
+  /**
+   * Usado para permitir múltipla seleção.
+   */
+  allowMultipleSelection: boolean;
+  /**
+   * Endereço do servidor para buscar os dados.
+   */
+  serverURL: string;
+  /**
+   * Repositório de dados, controla a manipulação dos dados.
+   */
+  dataUnit: DataUnit;
+  /**
+   * Configuração do valor da coluna de status.
+   * Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }
+   */
+  statusResolver: IStatusResolver | StatusResolverFunction;
+  /**
+   * Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade.
+   */
+  useEnterLikeTab: boolean;
+  /**
+   * Antes de executar o salvamento da edição, pode-se atribuir um validador de registros.
+   */
+  recordsValidator?: IRecordValidator;
+  /**
+   * Desabilita edição na grade independente da configuração de coluna.
+   */
+  editionIsDisabled?: () => boolean;
+}
+/**
+ * Representa cada coluna da grade.
+ */
+export interface EzGridColumn {
+  /**
+   * Texto a ser apresentado como título da coluna.
+   */
+  label: string;
+  /**
+   * ID da coluna. Em cada linha do array de dados, esse ID deve coincidir com
+   * o nome do atributo que a coluna representa.
+   */
+  name: string;
+  /**
+   * [Opcional] Representa a ordenação da coluna. Pode variar entre ASC e DESC
+   */
+  sort?: string;
+  /**
+   * [Opcional] Número inteiro positivo que representa a sequência de ordenação.
+   * Importante quando há ordenação por mais de uma coluna.
+   */
+  sortIndex?: number;
+  /**
+   * [Opcional] Largura da coluna em pixels absolutos.
+   */
+  width?: number;
+  /**
+   * [Opcional] Indica que a coluna está fixada.
+   */
+  pinned?: boolean;
+  /**
+   * [Opcional] Indica que a coluna não está visível.
+   */
+  hidden?: boolean;
+  /**
+   * [Opcional] Indica o tipo de dado renderizado na coluna.
+   */
+  userInterface?: string;
+  /**
+   * [Opcional] Utilizado no caso do campo do tipo combo-box.
+   */
+  options?: any;
+  /**
+   * [Opcional] Posição em que a coluna deve ser fixada.
+   */
+  pinnedPosition?: string;
+  /**
+   * [Opcional] Define propriedades especiais da coluna
+   */
+  props?: Map<string, any>;
+}
+/**
+ * Interface utilizada para se inserir menus personalizados no cabeçalho das colunas.
+ */
+export interface EzGridColumnMenuItemDef {
+  /**
+   * Texto a ser apresentado como título do item de menu.
+   */
+  label: string;
+  /**
+   * Identificador do item de menu. Esse valor será disponibilizado junto com o ID da
+   * coluna ao disparar a ação respectiva.
+   */
+  name: string;
+  /**
+   * Ação executada quando o usuário aciona o menu.
+   */
+  action: Function;
+  /**
+   * Ícone que deve ser exibido ao junto ao ítem de menu.
+   */
+  icon?: HTMLElement | string;
+}
+/**
+ * Evento de alteração de estado. Sempre que o estado das colunas for alterado, esse evento é disparado.
+ */
+export interface EzGridColumStateEvent {
+  /**
+   * Tipo de alteração de estado ["sort", "columnResize", "columnPinned", "columnMoved", "visibleChange"].
+   */
+  type: string;
+  /**
+   * O estado de todas as colunas depois da alteração. Usado para persistir o novo estado.
+   */
+  state: Array<EzGridColumn>;
+  /**
+  * Define se alteração foi realizada pelo usuário.
+  */
+  isUserChange: boolean;
+}
+export interface IGridConfig {
+  /**
+   * Lista de colunas a ser apresentada.
+   */
+  columns: Array<EzGridColumnConfig>;
+}
+export interface EzGridColumnConfig {
+  /**
+   * ID da coluna. Em cada linha do array de dados, esse ID deve coincidir com
+   * o nome do atributo que a coluna representa.
+   */
+  name: string;
+  /**
+   * Largura padrão da coluna em pixels absolutos.
+   */
+  width: number;
+  /**
+   * Número inteiro positivo que representa a sequência de ordenação.
+   * Importante quando há ordenação por mais de uma coluna.
+   */
+  orderIndex: number;
+  /**
+   * [Opcional] Define se a ordenação da coluna é ascendente ou descendente.
+   */
+  ascending?: boolean;
+  /**
+   * Largura customizada da coluna em pixels absolutos.
+   */
+  customWidth?: number;
+}
+export interface IStatusResolver {
+  [fieldName: string]: Map<String, any>;
+}
+export type StatusResolverFunction = (data: object) => string;

package/dist/types/components/ez-grid/controller/ag-grid/AgGridController.d.ts

@@ -0,0 +1,89 @@
+import { Sort, SortingProvider } from '@sankhyalabs/core';
+import { Filter, FilterProvider } from '@sankhyalabs/core/dist/dataunit/metadata/UnitMetadata';
+import { GridApi } from 'ag-grid-community';
+import EzGridController, { EzGridColumn, EzGridColumnConfig, EzGridColumnMenuItemDef, EzGridOptions } from '../EzGridController';
+export default class AgGridController implements EzGridController, SortingProvider, FilterProvider {
+  private readonly DEFAULT_ROW_HEIGHT;
+  private readonly DEFAULT_HEADER_ROW_HEIGHT;
+  private readonly CHECK_BOX_COL_ID;
+  private readonly STATUS_COL_ID;
+  private readonly RECORD_ARCHIVE_COL_ID;
+  private readonly BLOCK_LOAD_DEBOUNCE;
+  private readonly DEFAULT_FONT_SIZE;
+  private readonly DEFAULT_ICON_SIZE;
+  private readonly DEFAULT_MAX_SIZE;
+  private _grid;
+  private _gridOptions;
+  private _columnStateChangeCallback;
+  private _selectionChangeCallback;
+  private _doubleClickCallBack;
+  private _enterprise;
+  private _menuItems;
+  private _multipleSelection;
+  private _dataUnit;
+  private _idAttribName;
+  private _dataSource;
+  private _colDefs;
+  private _statusResolver;
+  private _selectionChangeDeboucing;
+  private _gridConfig;
+  private _filteredColumns;
+  private _filterColumn;
+  private _filterColumnleftPosition;
+  private _editionManager;
+  configFilterColumn(filterColumn: HTMLFilterColumnElement): void;
+  private handleFilteredColumnsChanged;
+  private showFilterColumn;
+  constructor(enterprise: boolean);
+  getGridConfig(): Array<EzGridColumnConfig>;
+  getGridApi(): GridApi;
+  getSort(): Array<Sort>;
+  getFilter(): Array<Filter> | undefined;
+  initDatagrid(container: HTMLElement, options: EzGridOptions): void;
+  private setFilterColumnLeftPosition;
+  private buildMenuItemOptions;
+  private buildMenuItemOptionSort;
+  private buildMenuItemFilterColumn;
+  private buildMenuItemOptionPin;
+  private sortDataByColumn;
+  private getRowHeight;
+  private getHeaderRowHeight;
+  private navigateToNextCell;
+  private defineRowModelType;
+  private setOptionsEvents;
+  private setOptionsSupress;
+  private getSelectionHeaderStatus;
+  private updateSelectionForAll;
+  setData(data: Array<any>): void;
+  addRows(): void;
+  updateRows(): void;
+  selectAll(quietly?: boolean): void;
+  selectRows(rowIds: Array<string>, quietly?: boolean): void;
+  removeRows(): void;
+  changeValues(changes: any, rowIds?: Array<string>): void;
+  refresh(): void;
+  setFocusFirstRow(): void;
+  setFocusLastRow(): void;
+  private setFocusOnRow;
+  setColumnsDef(cols: Array<EzGridColumn>): void;
+  getColumnsDef(): Array<EzGridColumn>;
+  setColumnsState(state: Array<EzGridColumnConfig>): void;
+  getColumnsState(): Array<EzGridColumn>;
+  getSelection(): Array<any>;
+  addColumnMenuItem(item: EzGridColumnMenuItemDef): void;
+  quickFilter(term: string): void;
+  setSelectedIndex(index: number): void;
+  hasFilterColumn(columnName: string): boolean;
+  private buildColDef;
+  private getInitCellStyle;
+  private getStyleByColumn;
+  private getFormatterByColumn;
+  private onCallStateChange;
+  private onCellClicked;
+  private isElementResize;
+  private isUIEvent;
+  private onSelectionChange;
+  private onRowDoubleClick;
+  private conditionalSet;
+  private getColumnWidth;
+}

package/dist/types/components/ez-grid/controller/ag-grid/AgGridUtils.d.ts

@@ -0,0 +1 @@
+export declare function calcFilterColumnLeftPosition(leftReference: number): number;

package/dist/types/components/ez-grid/controller/ag-grid/DataSource.d.ts

@@ -0,0 +1,20 @@
+import { IServerSideDatasource, IServerSideGetRowsParams } from "ag-grid-community";
+import { DataUnit, QuickFilter } from "@sankhyalabs/core";
+import EzGridController, { EzGridColumn, EzGridOptions } from "../EzGridController";
+export default class DataSource implements IServerSideDatasource {
+  private _controller;
+  private _dataUnit;
+  private _options;
+  private _lastLoadingParams;
+  private _waitingForLoad;
+  quickFilter: QuickFilter;
+  readonly RECORD_ARCHIVE = "__RECORD_ARCHIVE__";
+  private duObserver;
+  constructor(dataUnit: DataUnit, controller: EzGridController, options: EzGridOptions);
+  private updateSelection;
+  getRows(params: IServerSideGetRowsParams): void;
+  needReload(currentLoading: IServerSideGetRowsParams): boolean;
+  private callbackGetRows;
+  destroy(): void;
+  buildColumnDefs(): Array<EzGridColumn>;
+}

package/dist/types/components/ez-grid/controller/ag-grid/GridEditionManager.d.ts

@@ -0,0 +1,38 @@
+import { DataUnit } from "@sankhyalabs/core";
+import { CellPosition, ColDef, GridApi, GridOptions } from "ag-grid-community";
+import { IRecordValidator } from "../../../../utils/form/interfaces";
+export default class GridEditionManager {
+  private _dataUnit;
+  private _lastCellClicked;
+  private _lastCellEdited;
+  private _targetEditionCell;
+  private _recordValidationProcessor;
+  private _gridOptions;
+  private _useEnterLikeTab;
+  private _editionIsDisabled;
+  private _isGridEdition;
+  constructor(dataUnit: DataUnit, useEnterLikeTab: boolean, recordsValidator: IRecordValidator, editionIsDisabled: () => boolean);
+  configureGrid(options: GridOptions): GridOptions;
+  proceedAutoSave(): void;
+  navigateByEnterKey(keyboardEvent: KeyboardEvent): void;
+  getComponents(): {
+    [p: string]: any;
+  };
+  verifyClickToEdition(api: GridApi, cellClicked: CellPosition): void;
+  configureColumn(col: ColDef): ColDef;
+  private getRequiredFields;
+  private saveSuccess;
+  private saveFail;
+  private focusOnCell;
+  private onCellKeyDown;
+  private processEnterKey;
+  private nextEditionRow;
+  private editPreviousRow;
+  private editNextRow;
+  private moveEditionVertically;
+  private finishEdition;
+  private canEdit;
+  private isColEditable;
+  private isSecondClick;
+  private onCellEditRequest;
+}

package/dist/types/components/ez-grid/controller/ag-grid/components/EzGridCustomHeader.d.ts

@@ -0,0 +1,32 @@
+import { IHeaderParams } from 'ag-grid-community';
+export interface IEzGridCustomHeaderParams {
+  tooltip?: string;
+  hasFilter?: () => boolean;
+  showColumnFilter?: (leftPosition: string, fromIcon: boolean) => void;
+}
+export declare class EzGridCustomHeader {
+  private params;
+  private element;
+  private menuButton;
+  private headerContainer;
+  private sortUpIcon;
+  private sortDownIcon;
+  private filterButton;
+  private onFilterButtonClickListener;
+  private onMenuClickListener;
+  private onSortClickListener;
+  private onSortChangedListener;
+  private onFilterAppliedListener;
+  init(agParams: IEzGridCustomHeaderParams & IHeaderParams): void;
+  refresh(agParams: IEzGridCustomHeaderParams & IHeaderParams): void;
+  private configFilterButton;
+  private onClickFilter;
+  private configSortIcon;
+  private configSortListener;
+  private onSortClick;
+  private configSortClick;
+  private onMenuClick;
+  private configMenuClick;
+  getGui(): HTMLDivElement;
+  destroy(): void;
+}

package/dist/types/components/ez-grid/controller/ag-grid/components/cellRendererStatus.d.ts

@@ -0,0 +1,11 @@
+import { ICellRendererComp, ICellRendererParams } from "ag-grid-community";
+export declare class CellRendererStatus implements ICellRendererComp {
+  private readonly DEFAULT_COLOR;
+  private _eGui;
+  init(params: ICellRendererParams | any): void;
+  refresh(params: ICellRendererParams | any): boolean;
+  destroy(): void;
+  getGui(): any;
+  private resolveColor;
+  private renderStatus;
+}

package/dist/types/components/ez-grid/controller/ag-grid/components/selectionHeader.d.ts

@@ -0,0 +1,12 @@
+import { IHeaderParams, IHeaderComp } from "ag-grid-community";
+export default class SelectionHeader implements IHeaderComp {
+  private element;
+  private checkBox;
+  private headerCheckStatusGetter;
+  private updatingValue;
+  updateCheckbox(): void;
+  init(params: IHeaderParams): void;
+  getGui(): HTMLElement;
+  destroy(): void;
+  refresh(_params: IHeaderParams): boolean;
+}

package/dist/types/components/ez-grid/controller/ag-grid/editor/EzCellEditor.d.ts

@@ -0,0 +1,10 @@
+import { ICellEditorComp, ICellEditorParams } from "ag-grid-community";
+export default class EzCellEditor implements ICellEditorComp {
+  private _gui;
+  init(params: ICellEditorParams): void;
+  getGui(): HTMLElement;
+  afterGuiAttached(): void;
+  focusIn(): void;
+  getValue(): any;
+  isPopup(): boolean;
+}

package/dist/types/components/ez-grid/controller/ag-grid/editor/GridEditorUtils.d.ts

@@ -0,0 +1 @@
+export declare function getViewPortHeight(cell: Element): number | undefined;

package/dist/types/components/ez-grid/controller/ag-grid/editor/IEditorMetadata.d.ts

@@ -0,0 +1,9 @@
+import { DataUnit, FieldDescriptor } from '@sankhyalabs/core';
+import IAbstractFieldMetadata from '../../../../../utils/interfaces/AbstractFieldMetadata';
+import GridEditionManager from '../GridEditionManager';
+export interface IEditorMetadata extends IAbstractFieldMetadata {
+  eGridCell: HTMLElement;
+  dataUnit: DataUnit;
+  editionManager: GridEditionManager;
+}
+export declare const buildEditorMetadata: (descriptor: FieldDescriptor, eGridCell: HTMLElement, dataUnit: DataUnit, editionManager: GridEditionManager) => IEditorMetadata;

package/dist/types/components/ez-grid/controller/ag-grid/editor/IUICellEditor.d.ts

@@ -0,0 +1,10 @@
+export interface IUICellEditor extends HTMLElement {
+  setFocus: (options: IFocusOptions) => void;
+  value: any;
+  valueSetter?: (value: any) => void;
+  valueGetter?: () => any;
+  isPopUp?: boolean;
+}
+export interface IFocusOptions {
+  selectText: boolean;
+}

package/dist/types/components/ez-grid/controller/ag-grid/editor/templates/ComboBox.tpl.d.ts

@@ -0,0 +1,4 @@
+import { IEditorMetadata } from "../IEditorMetadata";
+import { IUICellEditor } from "../IUICellEditor";
+export declare const buildComboBox: ({ required, props, eGridCell }: IEditorMetadata) => IUICellEditor;
+export declare const buildSwitch: (fieldMetadata: IEditorMetadata) => IUICellEditor;

package/dist/types/components/ez-grid/controller/ag-grid/editor/templates/DateInput.tpl.d.ts

@@ -0,0 +1,5 @@
+import { IEditorMetadata } from "../IEditorMetadata";
+import { IUICellEditor } from "../IUICellEditor";
+export declare const buildDate: () => IUICellEditor;
+export declare const buildTime: ({ readOnly }: IEditorMetadata) => IUICellEditor;
+export declare const buildDateTime: ({ readOnly }: IEditorMetadata) => IUICellEditor;

package/dist/types/components/ez-grid/controller/ag-grid/editor/templates/NumberInput.tpl.d.ts

@@ -0,0 +1,4 @@
+import { IEditorMetadata } from "../IEditorMetadata";
+import { IUICellEditor } from "../IUICellEditor";
+export declare const buildDecimal: ({ readOnly, props }: IEditorMetadata) => IUICellEditor;
+export declare const buildInteger: ({ readOnly }: IEditorMetadata) => IUICellEditor;

package/dist/types/components/ez-grid/controller/ag-grid/editor/templates/Search.tpl.d.ts

@@ -0,0 +1,3 @@
+import { IUICellEditor } from "../IUICellEditor";
+import { IEditorMetadata } from '../IEditorMetadata';
+export declare const buildSearch: ({ name, required, readOnly, eGridCell, dataUnit }: IEditorMetadata) => IUICellEditor;

package/dist/types/components/ez-grid/controller/ag-grid/editor/templates/TextInput.tpl.d.ts

@@ -0,0 +1,4 @@
+import { IEditorMetadata } from "../IEditorMetadata";
+import { IUICellEditor } from "../IUICellEditor";
+export declare const buildTextInput: ({ name, contextName }: IEditorMetadata) => IUICellEditor;
+export declare const buildTextAreaInput: ({ eGridCell, editionManager }: IEditorMetadata) => IUICellEditor;

package/dist/types/components/ez-grid/controller/ag-grid/i18n/pt-BR.d.ts

@@ -0,0 +1,2 @@
+declare const gridTerms: any;
+export default gridTerms;

package/dist/types/components/ez-grid/controller/ag-grid/mock/Server.d.ts

@@ -0,0 +1,8 @@
+import { IServerSideGetRowsRequest, LoadSuccessParams } from "ag-grid-community";
+export default class Server {
+  private _data;
+  constructor(data: Array<any>);
+  getData(request: IServerSideGetRowsRequest): LoadSuccessParams;
+  private filter;
+  private sort;
+}