@sankhyalabs/sankhyablocks 9.2.0-ms.9 → 9.2.0-rc.2

package/dist/types/components/snk-simple-crud/snk-simple-crud.d.ts

@@ -46,152 +46,187 @@ export declare class SnkSimpleCrud {
   _fieldToGetFocus: string;
   _customContainerId: string;
   /**
-   * Define se o componente deve usar o LockManager para controle de carregamento da aplicação
+   * @description Define se o componente deve usar o LockManager para controle de carregamento da aplicação.
    */
   enableLockManagerLoadingComp?: boolean;
   /**
-   * Ativa o gerenciamento de locks na grade pela Taskbar.
+   * @description Ativa o gerenciamento de locks na grade pela Taskbar.
    */
   enableLockManagerTaskbarClick?: boolean;
+  /**
+   * @description Estado atual dos dados.
+   */
   dataState: DataState;
+  /**
+   * @description Instância do DataUnit a ser utilizada pelo componente.
+   */
   dataUnit: DataUnit;
   /**
-   * Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD
+   * @description Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD.
    */
   entityName: string;
+  /**
+   * @description Define o modo de operação do CRUD (servidor ou em memória).
+   */
   mode: SIMPLE_CRUD_MODE;
+  /**
+   * @description Configuração da grade.
+   */
   gridConfig: IGridConfig;
+  /**
+   * @description Configuração do formulário.
+   */
   formConfig: IFormConfig;
   _formFields: IFieldConfig[];
   private _fieldsProps;
+  /**
+   * @description Habilita a inserção contínua de registros.
+   */
   enableContinuousInsert: boolean;
   /**
-   * Determina se pode haver mais de uma linha selecionada na grade.
+   * @description Determina se pode haver mais de uma linha selecionada na grade.
    */
   multipleSelection: boolean;
+  /**
+   * @description Determina se será usada mensagem de confirmação padrão na tentativa de cancelar a edição.
+   */
   useCancelConfirm: boolean;
   /**
-   * Determina quantas linhas são retornadas por página.
+   * @description Determina quantas linhas são retornadas por página.
    */
   pageSize: number;
   /**
-   * Identificador de recursos como configurações e acesso.
+   * @description Identificador de recursos como configurações e acesso.
    */
   resourceID: string;
   /**
-   * Ativa inserção de registros no modo grade.
+   * @description Ativa a inserção de registros no modo grade.
    */
   enableGridInsert?: boolean;
   /**
-   * Define se a grid será focada ao ser carregada.
+   * @description Define o modo de exibição do contador de paginação.
    */
   paginationCounterMode?: 'show' | 'hidden' | 'auto';
   /**
-   * Emitido quando há qualquer mudança de estado no DataUnit.
+   * @description Emitido quando há qualquer mudança de estado no DataUnit.
    */
   dataStateChange: EventEmitter<DataState>;
   /**
-   * Emitido quando o DataUnit está pronto.
+   * @description Emitido quando o DataUnit está pronto.
    */
   dataUnitReady: EventEmitter<DataUnit>;
   /**
-   * Emitido sempre que houver click de botão ou ação.
+   * @description Emitido sempre que houver clique de botão ou ação na barra de tarefas.
    */
   actionClick: EventEmitter<string>;
   /**
-   * Responsável por notificar quando ocorrer a renderização de itens do formulário.
+   * @description Responsável por notificar quando ocorrer a renderização de itens do formulário.
    */
   formItemsReady: EventEmitter<Array<HTMLElement>>;
   /**
-   * Emitido quando salva a configuração no configurator do CRUD.
+   * @description Emitido quando a configuração no configurador do CRUD é salva.
    */
   configuratorSave: EventEmitter<any>;
   /**
-   * Emitido quando cancela o salvamento da configuração no configurator do CRUD.
+   * @description Emitido quando o salvamento da configuração no configurador do CRUD é cancelado.
    */
   configuratorCancel: EventEmitter<any>;
   /**
- * Gerenciador das barras de tarefas. É possível determinar botões específicos
- * ou mesmo gerenciar o estado dos botões.
- */
+  * @description Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões.
+  */
   taskbarManager: TaskbarManager;
   /**
-   * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
+   * @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
    */
   messagesBuilder: SnkMessageBuilder;
   /**
-   * Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade.
+   * @description Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade.
    */
   useEnterLikeTab: boolean;
   /**
-   * Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar.
+   * @description Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar.
    */
   actionsList: Array<Action>;
   /**
-   * Usado para salvar as configurações dos blocos de construção.
+   * @description Usado para salvar as configurações dos blocos de construção.
    */
   configName: string;
   /**
-   * Usado para exibir os botões de ação do snk-configurator.
+   * @description Usado para exibir os botões de ação do snk-configurator.
    */
   showConfiguratorButtons: boolean;
   /**
-   * Chave da configuração legado da grade.
+   * @description Chave da configuração legada da grade.
    */
   gridLegacyConfigName: string;
   /**
-   * Chave da configuração legado do formulário.
+   * @description Chave da configuração legada do formulário.
    */
   formLegacyConfigName: string;
   /**
-   * Ignora os campos "somente leitura" no modo de inserção.
+   * @description Ignora os campos "somente leitura" no modo de inserção.
    */
   ignoreReadOnlyFormFields: boolean;
   /**
-   * Define se a grid será focada ao ser carregada.
+   * @description Define se a grade será focada ao ser carregada.
    */
   autoFocus?: boolean;
   /**
-  * Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade)
-  */
+   * @description Define a chave customizada para sobrescrever as mensagens (não pegando pela entidade).
+   */
   domainMessagesBuilder: string;
   /**
-   * Habilita a edição de múltiplos registros simultâneos.
+   * @description Habilita a edição de múltiplos registros simultâneos.
    */
   multipleEditionEnabled: boolean;
   /**
-   * Define se o LayoutFormConfig será exibido no configurador.
+   * @description Define se o LayoutFormConfig será exibido no configurador.
    */
   layoutFormConfig: boolean;
   /**
-   * Registra um editor customizado para campos da grade e formulário.
+   * @description Registra um editor customizado para campos da grade e do formulário.
+   * @param {string} fieldName - O nome do campo.
+   * @param {ICustomEditor} customEditor - A instância do editor customizado.
+   * @returns {Promise<void>}
    */
   addCustomEditor(fieldName: string, customEditor: ICustomEditor): Promise<void>;
   /**
-   * Registra um render customizado para colunas da grid.
+   * @description Registra um renderizador customizado para colunas da grade.
+   * @param {string} fieldName - O nome do campo.
+   * @param {ICustomRender} customRender - A instância do renderizador customizado.
+   * @returns {Promise<void>}
    */
   addGridCustomRender(fieldName: string, customRender: ICustomRender): Promise<void>;
   /**
-   * Define se a carga dos dados será feita assim que o componente for carregado.
+   * @description Define se a carga dos dados será feita assim que o componente for carregado.
    */
   autoLoad?: boolean;
   /**
-  * Altera visualmente as sombras e bordas do componente
-  * Quando false, aplica o padrão de sombras ao componente (Utilizar quando for o elemento principal do layout)
-  * Quando true, aplica o padrão de outline ao componente (Utilizar quando estiver contido em outro elemento como um painel ou pop-up)
-  */
+   * @description Altera visualmente as sombras e bordas do componente.
+   * Quando `false`, aplica o padrão de sombras ao componente (utilizar quando for o elemento principal do layout).
+   * Quando `true`, aplica o padrão de contorno ao componente (utilizar quando estiver contido em outro elemento como um painel ou pop-up).
+   */
   outlineMode?: boolean;
   handleResourceIDChanged(newValue: string, oldValue: string): Promise<void>;
   /**
-   * Registra um formatador de valores para uma coluna da grid.
+   * @description Registra um formatador de valores para uma coluna da grade.
+   * @param {string} columnName - O nome da coluna.
+   * @param {ICustomFormatter} customFormatter - A instância do formatador customizado.
+   * @returns {Promise<void>}
    */
   addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter): Promise<void>;
   /**
-   * Remove o formatador de valores de uma coluna da grid.
+   * @description Remove o formatador de valores de uma coluna da grade.
+   * @param {string} columnName - O nome da coluna.
+   * @returns {Promise<void>}
    */
   removeCustomValueFormatter(columnName: string): Promise<void>;
   /**
-   * Altera/adiciona uma propriedade nos metadados do campo.
+   * @description Altera/adiciona uma propriedade nos metadados do campo.
+   * @param {string} fieldName - O nome do campo.
+   * @param {string} propName - O nome da propriedade.
+   * @param {any} value - O valor da propriedade.
+   * @returns {Promise<void>}
    */
   setFieldProp(fieldName: string, propName: string, value: any): Promise<void>;
   private loadTaskbarProcessor;
@@ -202,7 +237,9 @@ export declare class SnkSimpleCrud {
   private get application();
   resolveInMemoryBtns(taskbarButtons: Array<string>): Array<string>;
   /**
-   * Usado para alternar a visão entre GRID e FORM externamente.
+   * @description Usado para alternar a visão entre GRID e FORM externamente.
+   * @param {VIEW_MODE} view - A visão para a qual navegar.
+   * @returns {Promise<void>}
    */
   goToView(view: VIEW_MODE): Promise<void>;
   actionClickListener(evt: CustomEvent): void;
@@ -236,17 +273,37 @@ export declare class SnkSimpleCrud {
   private setFieldsProps;
   getTaskBarId(): string;
   initInMemoryDataUnit(): void;
+  /**
+   * @description Define os metadados do DataUnit.
+   * @param {UnitMetadata} metadata - Os metadados a serem definidos.
+   * @returns {Promise<void>}
+   */
   setMetadata(metadata: UnitMetadata): Promise<void>;
+  /**
+   * @description Define os registros do DataUnit.
+   * @param {Array<Record>} records - Os registros a serem definidos.
+   * @returns {Promise<void>}
+   */
   setRecords(records: Array<Record>): Promise<void>;
+  /**
+   * @description Obtém os registros do DataUnit.
+   * @returns {Promise<Array<Record>>} Uma promessa que resolve com a lista de registros.
+   */
   getRecords(): Promise<Array<Record>>;
   /**
-   * Usado para abrir o configurator do CRUD
+   * @description Usado para abrir o configurador do CRUD.
+   * @returns {Promise<void>}
    */
   openConfigurator(): Promise<void>;
   /**
-   * Usado para fechar o configurator do CRUD
+   * @description Usado para fechar o configurador do CRUD.
+   * @returns {Promise<void>}
    */
   closeConfigurator(): Promise<void>;
+  /**
+   * @description Atualiza a configuração do formulário.
+   * @returns {Promise<void>}
+   */
   updateConfig(): Promise<void>;
   processMetadata(): void;
   private addGridCustomValueFormattters;