@sankhyalabs/sankhyablocks 1.3.33 → 1.4.0-beta.1

package/dist/types/components/snk-application/snk-application.d.ts

@@ -1,9 +1,9 @@
 import { EventEmitter } from "../../stencil-public-runtime";
 import { DataUnit } from "@sankhyalabs/core";
 import DataUnitFetcher from "../../lib/http/data-fetcher/fetchers/dataunit-fetcher";
-import { RequestListener } from "../../lib/http/data-fetcher/DataFetcher";
+import { RequestListener, RequestListenerParams } from "../../lib/http/data-fetcher/DataFetcher";
 import ParametersFetcher from "../../lib/http/data-fetcher/fetchers/parameters-fecher";
-import { MessageOptions } from "@sankhyalabs/ezui/dist/collection/utils";
+import { MessageOptions, DialogType } from "@sankhyalabs/ezui/dist/collection/utils";
 import { FormConfigFetcher } from "../../lib/http/data-fetcher/fetchers/form-config-fetcher";
 import { FieldConfig } from "@sankhyalabs/ezui/dist/types/components/ez-form/ez-form";
 import { IGridConfig } from "@sankhyalabs/ezui/dist/types/components/ez-grid/controller/EzGridController";
@@ -12,62 +12,185 @@ import { PesquisaFetcher } from "../../lib/http/data-fetcher/fetchers/pesquisa-f
 import { Option } from "@sankhyalabs/ezui/dist/types/components/ez-combo-box/ez-combo-box";
 import AuthFetcher, { AutorizationType } from "../../lib/http/data-fetcher/fetchers/auth-fetcher";
 import { SnkErrorHandler } from "./errorhandler/snk-error-handler";
+import { TotalsFetcher } from "../../lib/http/data-fetcher/fetchers/totals-fetcher";
+import { SnkMessageBuilder } from "../../lib/message/SnkMessageBuilder";
+import FilterBarConfigFetcher from "../../lib/http/data-fetcher/fetchers/filter-bar-config-fetcher";
+import { SnkFilterItemConfig } from "../snk-filter-bar/filter-item/snk-filter-item";
+import { Filter } from "@sankhyalabs/core";
 export declare class SnkApplication {
   _parameters: ParametersFetcher;
   _urlParams: Map<string, any>;
   _dataUnitFetcher: DataUnitFetcher;
   _formConfigFetcher: FormConfigFetcher;
   _gridConfigFetcher: GridConfigFetcher;
+  _totalsFetcher: TotalsFetcher;
   _pesquisaFetcher: PesquisaFetcher;
   _authFetcher: AuthFetcher;
+  _filterBarConfigFetcher: FilterBarConfigFetcher;
   _resourceID: string;
   _popUp: HTMLEzPopupElement;
   _errorHandler: SnkErrorHandler;
+  _authPromises: Array<PendingPromise>;
+  _filterConfigPromise: Promise<Array<SnkFilterItemConfig>>;
+  _filterBarConfig: Array<SnkFilterItemConfig>;
+  _duCache: Map<string, DataUnit>;
+  _duPromises: Map<string, Array<PendingPromise>>;
   _requestListener: RequestListenerLoadingBar;
   private _auth;
   private get parameters();
   private get resourceID();
   private get auth();
+  /**
+   * messagesBuilder é um utilitário responsável por flexibilizar e padronizar
+   * o uso de mensagens nos blocos de construção.
+   */
+  messagesBuilder: SnkMessageBuilder;
+  /**
+  * Usado para salvar as configurações dos blocos de construção.
+  */
+  configName: string;
+  /**
+   * Caso o usuário logado seja o SUP.
+   */
   isUserSup(): Promise<boolean>;
+  /**
+   * Se o usuário logado tem permissão pra determinada ação.
+   */
   hasAccess(access: AutorizationType): Promise<boolean>;
+  /**
+   * Retorna todos os acessos do usuário logado.
+   */
   getAllAccess(): Promise<any>;
-  private getAuthList;
+  /**
+   * Retorna o valor de um parâmetro do tipo string.
+   */
   getStringParam(name: string): Promise<string>;
+  /**
+   * Retorna o valor de um parâmetro do tipo Inteiro.
+   */
   getIntParam(name: string): Promise<number>;
+  /**
+   * Retorna o valor de um parâmetro do tipo Decimal.
+   */
   getFloatParam(name: string): Promise<number>;
+  /**
+   * Retorna o valor de um parâmetro do tipo booleano.
+   */
   getBooleanParam(name: string): Promise<boolean>;
+  /**
+   * Retorna o valor de um parâmetro do tipo data.
+   */
   getDateParam(name: string): Promise<Date>;
+  /**
+   * Mostra o conteúdo passado em um Popup
+   */
   showPopUp(content: HTMLElement): Promise<void>;
+  /**
+   * Fecha o popup, liberando o conteúdo.
+   */
   closePopUp(): Promise<void>;
+  /**
+   * Verifica se a licença do cliente tem determinado opcional (produto)
+   */
   temOpcional(opcional: string): Promise<boolean>;
+  /**
+   * Retorna a configuração de um recurso por service broker
+   * Veja também o método "loadConfig"
+   */
   getConfig(key: string): Promise<any>;
+  /**
+   * Salva a configuração de determinado recurso.
+   */
   saveConfig(key: string, data: Object): Promise<any>;
+  /**
+   * Acessa informações de contexto "empurrados" na abertura da tela
+   */
   getAttributeFromHTMLWrapper(attribName: string): Promise<string>;
+  /**
+   * Abre determinada tela, repassando pkObject
+   */
   openApp(resourceId: string, pkObject: Object): Promise<void>;
-  createDataunit(entityName: string): Promise<DataUnit>;
+  private getDuPromissesStack;
+  /**
+   * Cria o DataUnit a partir do nome da entidade. É possível armazená-lo no cache
+   * passando o dataUnitName, assim, se mais de uma chamada for feita, o mesmo DataUnit será usado
+   */
+  createDataunit(entityName: string, dataUnitName?: string): Promise<DataUnit>;
+  /**
+   * Obtem um DataUnit do cache ou cria um caso ainda não tenha sido criado.
+   */
+  getDataUnit(entityName: string, dataUnitName: string): Promise<DataUnit>;
+  /**
+   * Retorna o resourceID da tela em questão.
+   */
   getResourceID(): Promise<string>;
+  /**
+   * Mostra o diálogo de alerta de acordo com os parâmetros passados.
+   */
   alert(title: string, message: string, icon?: string, options?: MessageOptions): Promise<boolean>;
+  /**
+   * Mostra o diálogo de erro de acordo com os parâmetros passados.
+   */
   error(title: string, message: string, icon?: string, options?: MessageOptions): Promise<boolean>;
-  confirm(title: string, message: string, icon?: string, critical?: boolean, options?: MessageOptions): Promise<boolean>;
+  /**
+   * Mostra o diálogo de sucesso de acordo com os parâmetros passados.
+   */
+  success(title: string, message: string, icon?: string, options?: MessageOptions): Promise<boolean>;
+  /**
+   * Exibe um diálogo de mensagem comum
+   */
+  message(title: string, message: string, icon?: string, options?: MessageOptions): Promise<boolean>;
+  /**
+   * Exibe um diálogo de confirmação
+   */
+  confirm(title: string, message: string, icon?: string, dialogType?: DialogType, options?: MessageOptions): Promise<boolean>;
+  /**
+   * Mostra uma informação efêmera (de segundo plano).
+   */
   info(message: string, options?: MessageOptions): Promise<void>;
+  /**
+   * Busca a configuração de formulário.
+   */
   loadFormConfig(name: string): Promise<Array<FieldConfig>>;
-  loadGridConfig(): Promise<IGridConfig>;
+  /**
+   * Busca a configuração de grade.
+   */
+  loadGridConfig(name: string): Promise<IGridConfig>;
+  /**
+   * Busca os totalizadores da grade.
+   */
+  loadTotals(name: string, resourceID: string, filters: Array<Filter>): Promise<Map<string, number>>;
+  /**
+   * Salva a configuração de grade.
+   */
   saveGridConfig(config: IGridConfig): Promise<boolean>;
-  private get urlParams();
-  private get dataUnitFetcher();
-  private get formConfigFetcher();
-  private get gridConfigFetcher();
-  private get pesquisaFetcher();
-  private get authFetcher();
+  /**
+   * Obtém as configurações da barra de filtros
+   */
+  getFilterBarConfig(name: string): Promise<Array<SnkFilterItemConfig>>;
+  /**
+   * Salva as configurações da barra de filtros
+   */
+  saveFilterBarConfig(config: Array<SnkFilterItemConfig>, name: string): Promise<boolean>;
   /**
    * Evento disparado quando a aplicação for carregada.
    */
   applicationLoaded: EventEmitter<boolean>;
   /**
-   * Evento
+   * Evento disparado ao iniciar a carga do componente
    */
   applicationLoading: EventEmitter<boolean>;
+  private getAuthList;
+  private get urlParams();
+  private get dataUnitFetcher();
+  private get formConfigFetcher();
+  private get gridConfigFetcher();
+  private get totalsFetcher();
+  private get pesquisaFetcher();
+  private get authFetcher();
+  private get filterBarConfigFetcher();
   executeSearch(searchArgument: any, fieldName: string, dataUnit: DataUnit): Promise<Array<Option> | Option>;
+  executePreparedSearch(mode: string, argument: string, options: any): Promise<Array<Option> | Option>;
   isDebugMode(): Promise<boolean>;
   private clearPopUpContent;
   private clearPopUpTitle;
@@ -80,10 +203,17 @@ export declare class SnkApplication {
 }
 declare class RequestListenerLoadingBar implements RequestListener {
   readonly _debounceTime: number;
+  readonly _ignoredNameTypes: string[];
   _timerLoading: any;
   _countRequest: number;
   loadingBar: HTMLEzLoadingBarElement;
-  onRequestStart(): void;
-  onRequestEnd(): void;
+  onRequestStart(param: RequestListenerParams): void;
+  onRequestEnd(param: RequestListenerParams): void;
+  private isIgnoreLoadingOnRequest;
+}
+declare class PendingPromise {
+  resolve: Function;
+  reject: Function;
+  constructor(resolve: Function, reject: Function);
 }
 export {};

package/dist/types/components/snk-filter-bar/filter-item/editors/snk-filter-binary-select.d.ts

@@ -0,0 +1,12 @@
+import { SnkFilterItemConfig } from '../snk-filter-item';
+export declare class SnkFilterBinarySelect {
+  _checkOne: HTMLEzCheckElement;
+  _checkTwo: HTMLEzCheckElement;
+  value: any;
+  config: SnkFilterItemConfig;
+  isSelected(option: string): boolean;
+  ezChangeListener(evt: CustomEvent): void;
+  assertCheckedOption(updatingCheck: HTMLElement): void;
+  updateValue(): void;
+  render(): any;
+}

package/dist/types/components/snk-filter-bar/filter-item/editors/snk-filter-multi-select.d.ts

@@ -0,0 +1,7 @@
+import { SnkFilterItemConfig } from '../snk-filter-item';
+export declare class SnkFilterMultiSelect {
+  value: any;
+  config: SnkFilterItemConfig;
+  ezChangeListener(evt: CustomEvent): void;
+  render(): any;
+}

package/dist/types/components/snk-filter-bar/filter-item/editors/snk-filter-number.d.ts

@@ -0,0 +1,7 @@
+import { SnkFilterItemConfig } from '../snk-filter-item';
+export declare class SnkFilterPeriod {
+  config: SnkFilterItemConfig;
+  value: number;
+  ezChangeListener(evt: CustomEvent): void;
+  render(): any;
+}

package/dist/types/components/snk-filter-bar/filter-item/editors/snk-filter-period.d.ts

@@ -0,0 +1,14 @@
+import { SnkFilterItemConfig } from '../snk-filter-item';
+export declare class SnkFilterPeriod {
+  _startDate: HTMLEzDateInputElement;
+  _endDate: HTMLEzDateInputElement;
+  config: SnkFilterItemConfig;
+  value: any;
+  ezChangeListener(): void;
+  getDate(prop: string): Date;
+  render(): any;
+}
+export interface Period {
+  start?: Date;
+  end?: Date;
+}

package/dist/types/components/snk-filter-bar/filter-item/editors/snk-filter-search.d.ts

@@ -0,0 +1,12 @@
+import { Option } from '@sankhyalabs/ezui/dist/types/components/ez-combo-box/ez-combo-box';
+import { SnkFilterItemConfig } from '../snk-filter-item';
+export declare class SnkFilterSearch {
+  config: SnkFilterItemConfig;
+  value: Option;
+  fix: () => void;
+  unfix: () => void;
+  _searchInput: HTMLEzSearchElement;
+  ezChangeListener(_evt: CustomEvent): void;
+  doSearch(mode: string, argument: string): Promise<Array<Option> | Option>;
+  render(): any;
+}

package/dist/types/components/snk-filter-bar/filter-item/editors/snk-filter-text.d.ts

@@ -0,0 +1,7 @@
+import { SnkFilterItemConfig } from '../snk-filter-item';
+export declare class SnkFilterText {
+  config: SnkFilterItemConfig;
+  value: string;
+  ezChangeListener(evt: CustomEvent): void;
+  render(): any;
+}

package/dist/types/components/snk-filter-bar/filter-item/filter-item-type.enum.d.ts

@@ -0,0 +1,9 @@
+declare enum FilterItemType {
+  MULTI_SELECT = "MULTI_SELECT",
+  BINARY_SELECT = "BINARY_SELECT",
+  PERIOD = "PERIOD",
+  SEARCH = "SEARCH",
+  TEXT = "TEXT",
+  NUMBER = "NUMBER"
+}
+export default FilterItemType;

package/dist/types/components/snk-filter-bar/filter-item/snk-filter-detail.d.ts

@@ -0,0 +1,14 @@
+import { EventEmitter } from '../../../stencil-public-runtime';
+import { SnkFilterItemConfig } from './snk-filter-item';
+export declare class SnkFilterDetail {
+  _editor: HTMLElement;
+  config: SnkFilterItemConfig;
+  keepOpened: boolean;
+  getMessage: (key: string, props?: any) => string;
+  filterChange: EventEmitter<SnkFilterItemConfig>;
+  changeConfig(newConfig: SnkFilterItemConfig): void;
+  getContentEditor(): string;
+  removeItem(): void;
+  getPopUpHeaderButtons(): any[];
+  render(): any;
+}

package/dist/types/components/snk-filter-bar/filter-list/snk-filter-list.d.ts

@@ -0,0 +1,40 @@
+import { EventEmitter } from '../../../stencil-public-runtime';
+export declare class SnkFilterList {
+  _element: HTMLElement;
+  _popoverContainer: HTMLElement;
+  _popover: HTMLElement;
+  _filterInput: HTMLEzFilterInputElement;
+  _floatingID: number;
+  _detailIsVisible: boolean;
+  _filterArgument: string;
+  _showAll: boolean;
+  label: string;
+  iconName: string;
+  items: Array<ListItem>;
+  getMessage: (key: string, props?: any) => string;
+  emptyText: string;
+  findFilterText: string;
+  buttonClass: string;
+  snkItemSelected: EventEmitter<string>;
+  private showList;
+  innerClickCheck: (floatingContainer: HTMLElement, node: HTMLElement) => boolean;
+  private hideList;
+  private buttonClick;
+  componentDidRender(): void;
+  buildItemElement(item: InternalListItem): HTMLElement;
+  itemSelected(itemName: string): void;
+  getFilterItems(): any;
+  getFooterItems(): ListItem[];
+  render(): any;
+}
+export interface ListItem {
+  label: string;
+  name: string;
+  kind: string;
+  iconName?: string;
+}
+interface InternalListItem extends ListItem {
+  iconClass?: string;
+  labelClass?: string;
+}
+export {};

package/dist/types/components/snk-filter-bar/snk-filter-bar.d.ts

@@ -0,0 +1,51 @@
+import { DataUnit } from '@sankhyalabs/core';
+import { SnkApplication } from '../snk-application/snk-application';
+import { SnkFilterItemConfig } from './filter-item/snk-filter-item';
+import { FilterProvider, Filter } from '@sankhyalabs/core/dist/dataunit/metadata/UnitMetadata';
+import { ListItem } from './filter-list/snk-filter-list';
+export declare class SnkFilterBar implements FilterProvider {
+  _element: HTMLElement;
+  _application: SnkApplication;
+  _updateSequence: Array<string>;
+  _calculateSortIndex: (item: SnkFilterItemConfig) => number;
+  _filtersComparator: (a: SnkFilterItemConfig, b: SnkFilterItemConfig) => number;
+  /**
+   * Recebe o DataUnit do ambiente. Se não for informado, procura pela referência
+   * do SnkDataUnit. Necessário para se registrar como provedor de filtros.
+   */
+  dataUnit: DataUnit;
+  /**
+   * Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade
+   * serve para separar a configuração de cada uma.
+   */
+  configName: string;
+  /**
+   * Lista de todos os filtros disponíveis ao usuário.
+   */
+  filterConfig: Array<SnkFilterItemConfig>;
+  /**
+   * Conforme mecanismo de mensagens, é possível customizar as mensagens dos blocos de construção
+   * através de um pequeno modulo na estrutura da aplicação:
+   * - Criar um arquivo no seguinte caminho: /messages/appmessages.msg.js.
+   * Para conhecer os detalhes do módulo, vide o arquivo neste projeto "/src/lib/message/resources/snk-filter-bar.msg.ts"
+   */
+  private getMessage;
+  getFilter(_dataUnit: string): Array<Filter>;
+  buildDUFilter(item: SnkFilterItemConfig): {
+    name: string;
+    expression: any;
+    params: any[];
+  };
+  componentWillLoad(): void;
+  getFilterItems(): Array<HTMLElement>;
+  calculateUpdateSequence(item: SnkFilterItemConfig): void;
+  filterChangeListener(evt: CustomEvent): void;
+  normalizeItem(item: SnkFilterItemConfig): SnkFilterItemConfig;
+  updateFilter(newItem: SnkFilterItemConfig, clear?: boolean): boolean;
+  getAddListItems(): Array<ListItem>;
+  getActiveClass(): "" | "sc-snk-filter-bar snk-filter-bar__filter-list-items-button--active";
+  getAppliedListItems(): Array<ListItem>;
+  addFilterHandler(itemName: string): void;
+  appliedFilterHandler(itemName: string): void;
+  render(): any;
+}

package/dist/types/components/snk-taskbar/elements/taskbar-elements.d.ts

@@ -0,0 +1,29 @@
+import { Action, CustomButton } from "../snk-taskbar";
+export declare enum TaskbarElement {
+  PREVIOUS = "PREVIOUS",
+  NEXT = "NEXT",
+  REFRESH = "REFRESH",
+  UPDATE = "UPDATE",
+  CLONE = "CLONE",
+  REMOVE = "REMOVE",
+  INSERT = "INSERT",
+  CANCEL = "CANCEL",
+  SAVE = "SAVE",
+  GRID_MODE = "GRID_MODE",
+  FORM_MODE = "FORM_MODE",
+  CONFIG_GRID = "CONFIG_GRID",
+  MORE_OPTIONS = "MORE_OPTIONS",
+  DIVIDER = "DIVIDER"
+}
+export declare enum AuthorizationElements {
+  UPDATE = "UPDATE",
+  CLONE = "CLONE",
+  REMOVE = "REMOVE",
+  INSERT = "INSERT",
+  CONFIG_GRID = "CONFIG_GRID"
+}
+export declare enum VisibleWhenForbidden {
+  CONFIG_GRID = "CONFIG_GRID"
+}
+export declare const buildCustomButton: (def: CustomButton, className: string, action: (name: string) => void, isEnabled: (name: string) => boolean) => HTMLElement;
+export declare const buildElem: (element: TaskbarElement, className: string, getTitle: (name: string) => string, action: (name: string) => void, isEnabled: (name: string) => boolean, actions: Array<Action>) => HTMLElement;

package/dist/types/components/snk-taskbar/processor/taskbar-processor.d.ts

@@ -0,0 +1,12 @@
+import { DataState } from "../../snk-data-unit/snk-data-unit";
+import { CustomButton, TaskbarManager } from "../snk-taskbar";
+export default class TaskbarProcessor {
+  private _defaultButtons;
+  buttons: string;
+  disabledButtons: Array<string>;
+  customButtons: Map<string, CustomButton>;
+  constructor(defaultButtons: any);
+  process(taskbarId: string, taskbarManager: TaskbarManager, dataState: DataState, disabledButtons?: Array<string>): void;
+  private getButtonsArray;
+  private isEnabled;
+}

package/dist/types/components/snk-taskbar/snk-taskbar.d.ts

@@ -0,0 +1,84 @@
+import { DataUnit } from '@sankhyalabs/core';
+import { EventEmitter } from '../../stencil-public-runtime';
+import { SnkApplication } from '../snk-application/snk-application';
+import { DataState } from '../snk-data-unit/snk-data-unit';
+import { TaskbarElement } from './elements/taskbar-elements';
+export declare class SnkTaskbar {
+  _application: SnkApplication;
+  /**
+   * Lista separada por virgula, contendo todos os elementos a serem criados
+   */
+  buttons: string;
+  /**
+   * Mapa com definição de botões personalizados. A chave do mapa deve ser
+   * passada na lista "buttons" no lugar onde o botão irá aparecer.
+   */
+  customButtons: Map<string, CustomButton>;
+  /**
+   * Lista de ações que devem ser usadas no botão "Mais opções"
+   */
+  actionsList: Array<Action>;
+  /**
+   * Qual botão deve ter aparência primária
+   */
+  primaryButton: string;
+  /**
+   * Array contendo todos os botões a serem desabilitados
+   */
+  disabledButtons: Array<string>;
+  /**
+   * Instância do DataUnit
+   */
+  dataUnit: DataUnit;
+  /**
+   * Emitido sempre que houver click de botão ou ação
+   */
+  actionClick: EventEmitter<string>;
+  _permissions: any;
+  _definitions: Array<string>;
+  _titleKeyByElement: {
+    UPDATE: string;
+    PREVIOUS: string;
+    NEXT: string;
+    REFRESH: string;
+    CLONE: string;
+    REMOVE: string;
+    MORE_OPTIONS: string;
+    INSERT: string;
+    CANCEL: string;
+    SAVE: string;
+    GRID_MODE: string;
+    CONFIG_GRID: string;
+    FORM_MODE: string;
+  };
+  observeButtons(): void;
+  elementsFromString(strButtons: string): Array<TaskbarElement>;
+  private isAllowed;
+  /**
+   * Conforme mecanismo de mensagens, é possível customizar as mensagens dos blocos de construção
+   * através de um pequeno modulo na estrutura da aplicação:
+   * - Criar um arquivo no seguinte caminho: /messages/appmessages.msg.js.
+   * Para conhecer os detalhes do módulo, vide o arquivo neste projeto "/src/lib/message/resources/snk-taskbar.msg.ts"
+   */
+  private getTitle;
+  private elementClick;
+  private isEnabled;
+  getElement(index: number, def: TaskbarElement | CustomButton): HTMLElement;
+  componentWillLoad(): void;
+  componentWillRender(): void;
+  render(): any;
+}
+export interface Action {
+  value: string;
+  label: string;
+}
+export interface CustomButton {
+  name: string;
+  hint: string;
+  text?: string;
+  iconName?: string;
+}
+export interface TaskbarManager {
+  getButtons: (taskbarId: string, dataState: DataState, currentButtons: Array<string>) => Array<string | CustomButton>;
+  isEnabled?: (taskbarId: string, dataState: DataState, buttonName: string, currentValue: boolean) => boolean;
+}