@sankhyalabs/sankhyablocks 1.3.31-beta.1 → 1.3.31-beta.11

package/dist/types/components.d.ts

@@ -5,47 +5,224 @@
  * It contains typing information for all components that exist in this project.
  */
 import { HTMLStencilElement, JSXBase } from "./stencil-public-runtime";
+import { SnkMessageBuilder } from "./lib/message/SnkMessageBuilder";
 import { AutorizationType } from "./lib/http/data-fetcher/fetchers/auth-fetcher";
 import { DataUnit } from "@sankhyalabs/core";
 import { MessageOptions } from "@sankhyalabs/ezui/dist/collection/utils";
-import { FieldConfig } from "@sankhyalabs/ezui/dist/types/components/ez-form/ez-form";
-import { EzGridConfig } from "@sankhyalabs/ezui/dist/types/components/ez-grid/controller/EzGridController";
+import { FieldConfig, RecordValidator } from "@sankhyalabs/ezui/dist/types/components/ez-form/ez-form";
+import { IGridConfig } from "@sankhyalabs/ezui/dist/types/components/ez-grid/controller/EzGridController";
 import { Option } from "@sankhyalabs/ezui/dist/types/components/ez-combo-box/ez-combo-box";
 import { SearchCriteria } from "./lib/http/data-fetcher/fetchers/pesquisa-fetcher";
+import { Action } from "./components/snk-taskbar/snk-taskbar";
+import { DataState } from "./components/snk-data-unit/snk-data-unit";
+import { Action as Action1 } from "./components/snk-taskbar/snk-taskbar";
 export namespace Components {
     interface SnkApplication {
+        /**
+          * Mostra o diálogo de alerta de acordo com os parâmetros passados.
+         */
         "alert": (title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>;
+        /**
+          * Fecha o popup, liberando o conteúdo.
+         */
         "closePopUp": () => Promise<void>;
+        /**
+          * Exibe um diálogo de confirmação
+         */
         "confirm": (title: string, message: string, icon?: string, critical?: boolean, options?: MessageOptions) => Promise<boolean>;
-        "createDataunit": (entityName: string) => Promise<DataUnit>;
+        /**
+          * 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>;
+        /**
+          * Mostra o diálogo de erro de acordo com os parâmetros passados.
+         */
         "error": (title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>;
         "executeSearch": (searchArgument: any, fieldName: string, dataUnit: DataUnit) => Promise<Array<Option> | Option>;
+        /**
+          * Retorna todos os acessos do usuário logado.
+         */
         "getAllAccess": () => Promise<any>;
+        /**
+          * Acessa informações de contexto "empurrados" na abertura da tela
+         */
         "getAttributeFromHTMLWrapper": (attribName: string) => Promise<string>;
+        /**
+          * Retorna o valor de um parâmetro do tipo booleano.
+         */
         "getBooleanParam": (name: 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>;
+        /**
+          * Obtem um DataUnit do cache ou cria um caso ainda não tenha sido criado.
+         */
+        "getDataUnit": (entityName: string, dataUnitName: string) => Promise<DataUnit>;
+        /**
+          * Retorna o valor de um parâmetro do tipo data.
+         */
         "getDateParam": (name: string) => Promise<Date>;
+        /**
+          * Retorna o valor de um parâmetro do tipo Decimal.
+         */
         "getFloatParam": (name: string) => Promise<number>;
+        /**
+          * Retorna o valor de um parâmetro do tipo Inteiro.
+         */
         "getIntParam": (name: string) => Promise<number>;
+        /**
+          * Retorna o resourceID da tela em questão.
+         */
         "getResourceID": () => Promise<string>;
+        /**
+          * Retorna o valor de um parâmetro do tipo string.
+         */
         "getStringParam": (name: string) => Promise<string>;
+        /**
+          * Se o usuário logado tem permissão pra determinada ação.
+         */
         "hasAccess": (access: AutorizationType) => Promise<boolean>;
+        /**
+          * Mostra uma informação efêmera (de segundo plano).
+         */
         "info": (message: string, options?: MessageOptions) => Promise<void>;
         "isDebugMode": () => Promise<boolean>;
+        /**
+          * Caso o usuário logado seja o SUP.
+         */
         "isUserSup": () => Promise<boolean>;
+        /**
+          * Busca a configuração de formulário.
+         */
         "loadFormConfig": (name: string) => Promise<Array<FieldConfig>>;
-        "loadGridConfig": () => Promise<EzGridConfig>;
+        /**
+          * Busca a configuração de grade.
+         */
+        "loadGridConfig": (name: string) => Promise<IGridConfig>;
+        /**
+          * messagesBuilder é um utilitário responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
+         */
+        "messagesBuilder": SnkMessageBuilder;
+        /**
+          * Abre determinada tela, repassando pkObject
+         */
         "openApp": (resourceId: string, pkObject: Object) => Promise<void>;
+        /**
+          * Salva a configuração de determinado recurso.
+         */
         "saveConfig": (key: string, data: Object) => Promise<any>;
-        "saveGridConfig": (config: EzGridConfig) => Promise<boolean>;
+        /**
+          * Salva a configuração de grade.
+         */
+        "saveGridConfig": (config: IGridConfig) => Promise<boolean>;
+        /**
+          * Mostra o conteúdo passado em um Popup
+         */
         "showPopUp": (content: HTMLElement) => Promise<void>;
+        /**
+          * Verifica se a licença do cliente tem determinado opcional (produto)
+         */
         "temOpcional": (opcional: string) => Promise<boolean>;
     }
+    interface SnkCrud {
+        "actionsList": Array<Action>;
+        "configName": string;
+        /**
+          * Validador responsável por checar a integridade das informações do registro
+         */
+        "recordsValidator": RecordValidator;
+    }
+    interface SnkDataUnit {
+        /**
+          * Executado após a ação de salvar
+         */
+        "afterSave": (dataUnit: DataUnit) => void;
+        /**
+          * Quando ativada essa propriedade faz com que haja uma carga imediata no DataUnit
+         */
+        "autoLoad": boolean;
+        /**
+          * Executado imediatamente antes da ação de salvar as alterações. Útil no caso de validações por exemplo. Caso retorne "false" (ou a promessa se resolva como false), cancela a ação.
+         */
+        "beforeSave": (dataUnit: DataUnit) => boolean | Promise<boolean>;
+        /**
+          * O estato atual dos dados, isto é se há alteração, insersão, as linhas selecionadas, etc.
+         */
+        "dataState": DataState;
+        /**
+          * Uma vez instanciado, pode-se obter o dataUnit por esta propriedade
+         */
+        "dataUnit": DataUnit;
+        /**
+          * Este atributo é usado para criar o dataUnit uma única vez. Se omitido será usado o próprio nome da entidade.
+         */
+        "dataUnitName": string;
+        /**
+          * Determina qual a entidade representa os dados em questão.
+         */
+        "entityName": string;
+        /**
+          * Pode-se obter o dataUnit através desse método. Outra forma, é ouvir o evento de
+          * @returns dataUnit
+         */
+        "getDataUnit": () => Promise<DataUnit>;
+        /**
+          * Determina quantas linhas são retornadas por página
+         */
+        "pageSize": number;
+    }
+    interface SnkForm {
+        /**
+          * Lista de ações que devem ser usadas no botão "Mais opções"
+         */
+        "actionsList": Array<Action>;
+        /**
+          * Nome usado para guardar/recuperar as configurações do formulário
+         */
+        "configName": string;
+        /**
+          * Validador responsável por checar a integridade das informações do registro
+         */
+        "recordsValidator": RecordValidator;
+    }
+    interface SnkGrid {
+        /**
+          * Lista de ações que devem ser usadas no botão "Mais opções"
+         */
+        "actionsList": Array<Action>;
+        /**
+          * Nome usado para salvar/recuperar a configuração
+         */
+        "configName": string;
+    }
     interface SnkPesquisa {
         "argument": string;
         "searchLoader": Function;
         "selectItem": Function;
     }
+    interface SnkTaskbar {
+        /**
+          * Lista de ações que devem ser usadas no botão "Mais opções"
+         */
+        "actionsList": Array<Action>;
+        /**
+          * Lista separada por virgula, contendo todos os elementos a serem criados
+         */
+        "buttons": string;
+        /**
+          * Instância do DataUnit
+         */
+        "dataUnit": DataUnit;
+        /**
+          * Array contendo todos os botões a serem desabilitados
+         */
+        "disabledButtons": Array<string>;
+        /**
+          * Qual botão deve ter aparência primária
+         */
+        "primaryButton": string;
+    }
     interface TestePesquisa {
     }
 }
@@ -53,6 +230,22 @@ export interface SnkApplicationCustomEvent<T> extends CustomEvent<T> {
     detail: T;
     target: HTMLSnkApplicationElement;
 }
+export interface SnkDataUnitCustomEvent<T> extends CustomEvent<T> {
+    detail: T;
+    target: HTMLSnkDataUnitElement;
+}
+export interface SnkFormCustomEvent<T> extends CustomEvent<T> {
+    detail: T;
+    target: HTMLSnkFormElement;
+}
+export interface SnkGridCustomEvent<T> extends CustomEvent<T> {
+    detail: T;
+    target: HTMLSnkGridElement;
+}
+export interface SnkTaskbarCustomEvent<T> extends CustomEvent<T> {
+    detail: T;
+    target: HTMLSnkTaskbarElement;
+}
 declare global {
     interface HTMLSnkApplicationElement extends Components.SnkApplication, HTMLStencilElement {
     }
@@ -60,12 +253,42 @@ declare global {
         prototype: HTMLSnkApplicationElement;
         new (): HTMLSnkApplicationElement;
     };
+    interface HTMLSnkCrudElement extends Components.SnkCrud, HTMLStencilElement {
+    }
+    var HTMLSnkCrudElement: {
+        prototype: HTMLSnkCrudElement;
+        new (): HTMLSnkCrudElement;
+    };
+    interface HTMLSnkDataUnitElement extends Components.SnkDataUnit, HTMLStencilElement {
+    }
+    var HTMLSnkDataUnitElement: {
+        prototype: HTMLSnkDataUnitElement;
+        new (): HTMLSnkDataUnitElement;
+    };
+    interface HTMLSnkFormElement extends Components.SnkForm, HTMLStencilElement {
+    }
+    var HTMLSnkFormElement: {
+        prototype: HTMLSnkFormElement;
+        new (): HTMLSnkFormElement;
+    };
+    interface HTMLSnkGridElement extends Components.SnkGrid, HTMLStencilElement {
+    }
+    var HTMLSnkGridElement: {
+        prototype: HTMLSnkGridElement;
+        new (): HTMLSnkGridElement;
+    };
     interface HTMLSnkPesquisaElement extends Components.SnkPesquisa, HTMLStencilElement {
     }
     var HTMLSnkPesquisaElement: {
         prototype: HTMLSnkPesquisaElement;
         new (): HTMLSnkPesquisaElement;
     };
+    interface HTMLSnkTaskbarElement extends Components.SnkTaskbar, HTMLStencilElement {
+    }
+    var HTMLSnkTaskbarElement: {
+        prototype: HTMLSnkTaskbarElement;
+        new (): HTMLSnkTaskbarElement;
+    };
     interface HTMLTestePesquisaElement extends Components.TestePesquisa, HTMLStencilElement {
     }
     var HTMLTestePesquisaElement: {
@@ -74,31 +297,169 @@ declare global {
     };
     interface HTMLElementTagNameMap {
         "snk-application": HTMLSnkApplicationElement;
+        "snk-crud": HTMLSnkCrudElement;
+        "snk-data-unit": HTMLSnkDataUnitElement;
+        "snk-form": HTMLSnkFormElement;
+        "snk-grid": HTMLSnkGridElement;
         "snk-pesquisa": HTMLSnkPesquisaElement;
+        "snk-taskbar": HTMLSnkTaskbarElement;
         "teste-pesquisa": HTMLTestePesquisaElement;
     }
 }
 declare namespace LocalJSX {
     interface SnkApplication {
+        /**
+          * messagesBuilder é um utilitário responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
+         */
+        "messagesBuilder"?: SnkMessageBuilder;
         /**
           * Evento disparado quando a aplicação for carregada.
          */
         "onApplicationLoaded"?: (event: SnkApplicationCustomEvent<boolean>) => void;
         /**
-          * Evento
+          * Evento disparado ao iniciar a carga do componente
          */
         "onApplicationLoading"?: (event: SnkApplicationCustomEvent<boolean>) => void;
     }
+    interface SnkCrud {
+        "actionsList"?: Array<Action>;
+        "configName"?: string;
+        /**
+          * Validador responsável por checar a integridade das informações do registro
+         */
+        "recordsValidator"?: RecordValidator;
+    }
+    interface SnkDataUnit {
+        /**
+          * Executado após a ação de salvar
+         */
+        "afterSave"?: (dataUnit: DataUnit) => void;
+        /**
+          * Quando ativada essa propriedade faz com que haja uma carga imediata no DataUnit
+         */
+        "autoLoad"?: boolean;
+        /**
+          * Executado imediatamente antes da ação de salvar as alterações. Útil no caso de validações por exemplo. Caso retorne "false" (ou a promessa se resolva como false), cancela a ação.
+         */
+        "beforeSave"?: (dataUnit: DataUnit) => boolean | Promise<boolean>;
+        /**
+          * O estato atual dos dados, isto é se há alteração, insersão, as linhas selecionadas, etc.
+         */
+        "dataState"?: DataState;
+        /**
+          * Uma vez instanciado, pode-se obter o dataUnit por esta propriedade
+         */
+        "dataUnit"?: DataUnit;
+        /**
+          * Este atributo é usado para criar o dataUnit uma única vez. Se omitido será usado o próprio nome da entidade.
+         */
+        "dataUnitName"?: string;
+        /**
+          * Determina qual a entidade representa os dados em questão.
+         */
+        "entityName"?: string;
+        /**
+          * Disparado quando se cancela uma insersão/cópia
+         */
+        "onCancelEdition"?: (event: SnkDataUnitCustomEvent<void>) => void;
+        /**
+          * Disparado quando o há qualquer mudança de estado no DataUnit
+         */
+        "onDataStateChange"?: (event: SnkDataUnitCustomEvent<DataState>) => void;
+        /**
+          * Disparado quando o DataUnit está pronto
+         */
+        "onDataUnitReady"?: (event: SnkDataUnitCustomEvent<DataUnit>) => void;
+        /**
+          * Disparado quando um registro é adicionado ou copiado
+         */
+        "onInsertionMode"?: (event: SnkDataUnitCustomEvent<void>) => void;
+        /**
+          * Determina quantas linhas são retornadas por página
+         */
+        "pageSize"?: number;
+    }
+    interface SnkForm {
+        /**
+          * Lista de ações que devem ser usadas no botão "Mais opções"
+         */
+        "actionsList"?: Array<Action>;
+        /**
+          * Nome usado para guardar/recuperar as configurações do formulário
+         */
+        "configName"?: string;
+        /**
+          * Emitido sempre que houver click de botão ou ação
+         */
+        "onActionClick"?: (event: SnkFormCustomEvent<string>) => void;
+        /**
+          * Emitido quando o botão de voltar é acionado
+         */
+        "onExit"?: (event: SnkFormCustomEvent<void>) => void;
+        /**
+          * Validador responsável por checar a integridade das informações do registro
+         */
+        "recordsValidator"?: RecordValidator;
+    }
+    interface SnkGrid {
+        /**
+          * Lista de ações que devem ser usadas no botão "Mais opções"
+         */
+        "actionsList"?: Array<Action>;
+        /**
+          * Nome usado para salvar/recuperar a configuração
+         */
+        "configName"?: string;
+        /**
+          * Emitido sempre que houver click de botão ou ação
+         */
+        "onActionClick"?: (event: SnkGridCustomEvent<string>) => void;
+        /**
+          * Emitido sempre que houver duplo click na grade
+         */
+        "onGridDoubleClick"?: (event: SnkGridCustomEvent<void>) => void;
+    }
     interface SnkPesquisa {
         "argument"?: string;
         "searchLoader"?: Function;
         "selectItem"?: Function;
     }
+    interface SnkTaskbar {
+        /**
+          * Lista de ações que devem ser usadas no botão "Mais opções"
+         */
+        "actionsList"?: Array<Action>;
+        /**
+          * Lista separada por virgula, contendo todos os elementos a serem criados
+         */
+        "buttons"?: string;
+        /**
+          * Instância do DataUnit
+         */
+        "dataUnit"?: DataUnit;
+        /**
+          * Array contendo todos os botões a serem desabilitados
+         */
+        "disabledButtons"?: Array<string>;
+        /**
+          * Emitido sempre que houver click de botão ou ação
+         */
+        "onActionClick"?: (event: SnkTaskbarCustomEvent<string>) => void;
+        /**
+          * Qual botão deve ter aparência primária
+         */
+        "primaryButton"?: string;
+    }
     interface TestePesquisa {
     }
     interface IntrinsicElements {
         "snk-application": SnkApplication;
+        "snk-crud": SnkCrud;
+        "snk-data-unit": SnkDataUnit;
+        "snk-form": SnkForm;
+        "snk-grid": SnkGrid;
         "snk-pesquisa": SnkPesquisa;
+        "snk-taskbar": SnkTaskbar;
         "teste-pesquisa": TestePesquisa;
     }
 }
@@ -107,7 +468,12 @@ declare module "@stencil/core" {
     export namespace JSX {
         interface IntrinsicElements {
             "snk-application": LocalJSX.SnkApplication & JSXBase.HTMLAttributes<HTMLSnkApplicationElement>;
+            "snk-crud": LocalJSX.SnkCrud & JSXBase.HTMLAttributes<HTMLSnkCrudElement>;
+            "snk-data-unit": LocalJSX.SnkDataUnit & JSXBase.HTMLAttributes<HTMLSnkDataUnitElement>;
+            "snk-form": LocalJSX.SnkForm & JSXBase.HTMLAttributes<HTMLSnkFormElement>;
+            "snk-grid": LocalJSX.SnkGrid & JSXBase.HTMLAttributes<HTMLSnkGridElement>;
             "snk-pesquisa": LocalJSX.SnkPesquisa & JSXBase.HTMLAttributes<HTMLSnkPesquisaElement>;
+            "snk-taskbar": LocalJSX.SnkTaskbar & JSXBase.HTMLAttributes<HTMLSnkTaskbarElement>;
             "teste-pesquisa": LocalJSX.TestePesquisa & JSXBase.HTMLAttributes<HTMLTestePesquisaElement>;
         }
     }

package/dist/types/lib/http/data-fetcher/fetchers/dataunit-fetcher.d.ts

@@ -1,11 +1,13 @@
 import { DataUnit } from "@sankhyalabs/core";
 export default class DataUnitFetcher {
   private templateByQuery;
+  private _loadDataTimeout;
   constructor();
   private buldTemplates;
   getDataUnit(entityName: string, resourceID: string): DataUnit;
   private loadMetadata;
   private loadData;
+  private doLoadData;
   private saveData;
   private removeRecords;
 }

package/dist/types/lib/http/data-fetcher/fetchers/grid-config-fetcher.d.ts

@@ -1,7 +1,7 @@
-import { EzGridConfig } from "@sankhyalabs/ezui/dist/types/components/ez-grid/controller/EzGridController";
+import { IGridConfig } from "@sankhyalabs/ezui/dist/types/components/ez-grid/controller/EzGridController";
 import { ResourceFetcher } from "./resource-fetcher";
 export default class GridConfigFetcher extends ResourceFetcher {
   readonly GRID_CONFIG_VERSION = "V3:";
-  getConfig(resourceID: string): Promise<EzGridConfig>;
-  saveConfig(config: EzGridConfig, resourceID: string): Promise<boolean>;
+  getConfig(_gridName: string, resourceID: string): Promise<IGridConfig>;
+  saveConfig(config: IGridConfig, resourceID: string): Promise<boolean>;
 }

package/dist/types/lib/message/SnkMessageBuilder.d.ts

@@ -0,0 +1,42 @@
+export declare class SnkMessageBuilder {
+  private _appMessages;
+  private _defaults;
+  private _currentOperation;
+  /**
+   * É possível definir um ponteiro de função para modificar
+   * a mensagem de acordo com a conveniência da aplicação
+   */
+  customMessageBuilder: (key: string, defaultMessage: string, params: any) => {
+    message: string;
+    params: any;
+  };
+  constructor();
+  /**
+   * Existem mensagens sensíveis a operação. Por exemplo, a mensagem
+   * de inclusão pode ser diferente da mensagem de alteração do mesmo
+   * recurso. Para isso "currentOperation" pode variar de acordo com
+   * OperationMap.
+   */
+  set currentOperation(op: OperationMap);
+  /**
+   * Método usado para se obter mensagens, respeitando o padrão do sistema
+   * ou as mensagens específicas de cada tela
+   *
+   * @param key Chave usada para obter mensagens. Deve-se usar o separador "."
+   * alcançar diversos níveis.
+   * @param params Quando a mensagem possui o padrão {{NOME}} as ocorrências
+   * serão substituidas pelo respectivo valor do param.
+   * @returns A mensagem formatada.
+   */
+  getMessage(key: string, params: any): string;
+  private resolveMessage;
+  private isOperationSensitive;
+  private postProcess;
+  private loadAppMessages;
+}
+export declare enum OperationMap {
+  CLONE = "clone",
+  INSERT = "insert",
+  UPDATE = "update",
+  CLEAN = "clean"
+}

package/dist/types/lib/message/resources/snk-data-unit.msg.d.ts

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

package/dist/types/lib/message/resources/snk-form.msg.d.ts

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

package/dist/types/lib/message/resources/snk-taskbar.msg.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sankhyalabs/sankhyablocks",
-  "version": "1.3.31-beta.1",
+  "version": "1.3.31-beta.11",
   "description": "Stencil Component Starter",
   "main": "dist/index.cjs.js",
   "module": "dist/index.js",
@@ -36,8 +36,8 @@
   },
   "devDependencies": {
     "@babel/preset-env": "^7.18.2",
-    "@sankhyalabs/core": "^1.0.64",
-    "@sankhyalabs/ezui": "^1.1.139",
+    "@sankhyalabs/core": "^1.0.71-beta.3",
+    "@sankhyalabs/ezui": "^1.1.158-beta.3",
     "@sankhyalabs/skippeerdeps": "^1.0.2",
     "@semantic-release/git": "^9.0.0",
     "@semantic-release/gitlab": "^6.1.0",
@@ -60,8 +60,8 @@
     "verbose": true
   },
   "peerDependencies": {
-    "@sankhyalabs/core": "^1.x",
-    "@sankhyalabs/ezui": "^1.x"
+    "@sankhyalabs/core": "^1.0.71-beta.0",
+    "@sankhyalabs/ezui": "^1.1.158-beta.0"
   },
   "license": "MIT"
 }