@sankhyalabs/sankhyablocks 9.2.0-dev.11 → 9.2.0-dev.13

package/dist/cjs/snk-personalized-filter.cjs.entry.js

@@ -47,8 +47,10 @@ const SnkPersonalizedFilter = class {
     this.resourceID = undefined;
     this.isDefaultFilter = false;
   }
-  /*
-   * Cria um novo filtro se não houver nenhum filtro existente
+  /**
+   * Cria um novo filtro personalizado caso não exista nenhum.
+   * @method
+   * @returns {Promise<void>}
    */
   async createPersonalizedFilter() {
     const newPersonalizedFilter = {
@@ -84,6 +86,12 @@ const SnkPersonalizedFilter = class {
     this._originalFilterAssistent = core.ObjectUtils.copy(newPersonalizedFilter);
     this._filterAssistent = core.ObjectUtils.copy(newPersonalizedFilter);
   }
+  /**
+   * Carrega o filtro personalizado com base no identificador informado.
+   * @watch filterId
+   * @param newValue Novo valor do filtroId.
+   * @param oldValue Valor anterior do filtroId.
+   */
   loadFilter(newValue, oldValue) {
     if (newValue == null || oldValue == newValue || this.resourceID == undefined) {
       return;

package/dist/cjs/snk-simple-bar.cjs.entry.js

@@ -17,11 +17,11 @@ const SnkSimpleBar = class {
     this.messagesBuilder = undefined;
   }
   /**
-   * 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-simple-bar.msg.ts"
-  */
+   * Permite customizar as mensagens dos blocos de construção
+   * através de um pequeno módulo na estrutura da aplicação:
+   * - Crie um arquivo no seguinte caminho: /messages/appmessages.msg.js.
+   * Para conhecer os detalhes do módulo, veja o arquivo neste projeto: "/src/lib/message/resources/snk-simple-bar.msg.ts"
+   */
   getMessage(key, params) {
     var _a;
     if (this.messagesBuilder)

package/dist/cjs/snk-simple-crud.cjs.entry.js

@@ -86,7 +86,10 @@ const SnkSimpleCrud = class {
     this.outlineMode = false;
   }
   /**
-   * 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>}
    */
   async addCustomEditor(fieldName, customEditor) {
     if (this._grid && this._form) {
@@ -99,7 +102,10 @@ const SnkSimpleCrud = class {
     this._customEditors = newCustomEditors;
   }
   /**
-   * 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>}
    */
   async addGridCustomRender(fieldName, customRender) {
     if (this._grid) {
@@ -121,19 +127,28 @@ const SnkSimpleCrud = class {
     await this.loadGridConfig(true);
   }
   /**
-   * 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>}
    */
   async addCustomValueFormatter(columnName, customFormatter) {
     this._grid.addCustomValueFormatter(columnName, customFormatter);
   }
   /**
-   * 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>}
    */
   async removeCustomValueFormatter(columnName) {
     this._grid.removeCustomValueFormatter(columnName);
   }
   /**
-   * 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>}
    */
   async setFieldProp(fieldName, propName, value) {
     const newCustomFieldProps = new Map(this._fieldsProps);
@@ -190,7 +205,9 @@ const SnkSimpleCrud = class {
     return newTaskBarConfig;
   }
   /**
-   * 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>}
    */
   async goToView(view) {
     this._currentViewMode = view;
@@ -464,6 +481,11 @@ const SnkSimpleCrud = class {
     this.dataUnit = this._inMemoryLoader.dataUnit;
     this.dataUnitReady.emit(this.dataUnit);
   }
+  /**
+   * @description Define os metadados do DataUnit.
+   * @param {UnitMetadata} metadata - Os metadados a serem definidos.
+   * @returns {Promise<void>}
+   */
   setMetadata(metadata) {
     if (this._inMemoryLoader) {
       this._inMemoryLoader.metadata = metadata;
@@ -473,6 +495,11 @@ const SnkSimpleCrud = class {
     }
     return Promise.resolve();
   }
+  /**
+   * @description Define os registros do DataUnit.
+   * @param {Array<Record>} records - Os registros a serem definidos.
+   * @returns {Promise<void>}
+   */
   setRecords(records) {
     if (this._inMemoryLoader) {
       this._inMemoryLoader.records = records;
@@ -482,23 +509,33 @@ const SnkSimpleCrud = class {
     }
     return Promise.resolve();
   }
+  /**
+   * @description Obtém os registros do DataUnit.
+   * @returns {Promise<Array<Record>>} Uma promessa que resolve com a lista de registros.
+   */
   getRecords() {
     return Promise.resolve(this.dataUnit.records);
   }
   /**
-   * Usado para abrir o configurator do CRUD
+   * @description Usado para abrir o configurador do CRUD.
+   * @returns {Promise<void>}
    */
   async openConfigurator() {
     var _a;
     (_a = this._snkConfigurator) === null || _a === void 0 ? void 0 : _a.open();
   }
   /**
-   * Usado para fechar o configurator do CRUD
+   * @description Usado para fechar o configurador do CRUD.
+   * @returns {Promise<void>}
    */
   async closeConfigurator() {
     var _a;
     (_a = this._snkConfigurator) === null || _a === void 0 ? void 0 : _a.close();
   }
+  /**
+   * @description Atualiza a configuração do formulário.
+   * @returns {Promise<void>}
+   */
   async updateConfig() {
     if (this._formConfigManager == undefined) {
       this._formConfigManager = new SnkFormConfigManager.SnkFormConfigManager(this.configName, this.resolveResourceID());

package/dist/collection/components/snk-personalized-filter/snk-personalized-filter.js

@@ -1,3 +1,21 @@
+/**
+ * Componente responsável pela criação, edição e gerenciamento de filtros personalizados.
+ *
+ * Permite alternar entre os modos assistente e avançado, salvar, cancelar e manipular filtros.
+ *
+ * @component
+ * @example
+ * <snk-personalized-filter
+ *    entityUri="sua/entidade"
+ *    filterId="idFiltro"
+ *    configName="nomeConfig"
+ *    resourceID="resourceId"
+ *    isDefaultFilter={false}
+ *    messagesBuilder={messagesBuilderInstance}
+ *    onEzSave={handler}
+ *    onEzCancel={handler}
+ * />
+ */
 import { h, Host, Fragment } from '@stencil/core';
 import { ApplicationContext, StringUtils } from '@sankhyalabs/core';
 import { PersonalizedFilterUtils } from './subcomponents/snk-filter-param-config/utils/PersonalizedFilterUtils';
@@ -34,8 +52,10 @@ export class SnkPersonalizedFilter {
     this.resourceID = undefined;
     this.isDefaultFilter = false;
   }
-  /*
-   * Cria um novo filtro se não houver nenhum filtro existente
+  /**
+   * Cria um novo filtro personalizado caso não exista nenhum.
+   * @method
+   * @returns {Promise<void>}
    */
   async createPersonalizedFilter() {
     const newPersonalizedFilter = {
@@ -71,6 +91,12 @@ export class SnkPersonalizedFilter {
     this._originalFilterAssistent = ObjectUtils.copy(newPersonalizedFilter);
     this._filterAssistent = ObjectUtils.copy(newPersonalizedFilter);
   }
+  /**
+   * Carrega o filtro personalizado com base no identificador informado.
+   * @watch filterId
+   * @param newValue Novo valor do filtroId.
+   * @param oldValue Valor anterior do filtroId.
+   */
   loadFilter(newValue, oldValue) {
     if (newValue == null || oldValue == newValue || this.resourceID == undefined) {
       return;
@@ -357,7 +383,10 @@ export class SnkPersonalizedFilter {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
+          "tags": [{
+              "name": "property",
+              "text": undefined
+            }],
           "text": "Respons\u00E1vel por flexibilizar e padronizar o uso de mensagens nos blocos de constru\u00E7\u00E3o."
         }
       },
@@ -372,8 +401,11 @@ export class SnkPersonalizedFilter {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Respons\u00E1vel por receber a URI da entidade."
+          "tags": [{
+              "name": "property",
+              "text": undefined
+            }],
+          "text": "URI da entidade utilizada para buscar os campos dispon\u00EDveis para filtro."
         },
         "attribute": "entity-uri",
         "reflect": false
@@ -389,8 +421,11 @@ export class SnkPersonalizedFilter {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Id do filtro que ser\u00E1 carregado."
+          "tags": [{
+              "name": "property",
+              "text": undefined
+            }],
+          "text": "Identificador do filtro a ser carregado."
         },
         "attribute": "filter-id",
         "reflect": false
@@ -406,8 +441,11 @@ export class SnkPersonalizedFilter {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Nome da configura\u00E7\u00E3o. Serve para distinguir v\u00E1rias inst\u00E2ncias do componente."
+          "tags": [{
+              "name": "property",
+              "text": undefined
+            }],
+          "text": "Nome da configura\u00E7\u00E3o, utilizado para distinguir m\u00FAltiplas inst\u00E2ncias do componente."
         },
         "attribute": "config-name",
         "reflect": false
@@ -423,8 +461,11 @@ export class SnkPersonalizedFilter {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Nome da configura\u00E7\u00E3o. Serve para distinguir v\u00E1rias inst\u00E2ncias do componente."
+          "tags": [{
+              "name": "property",
+              "text": undefined
+            }],
+          "text": "Identificador do recurso utilizado para salvar e recuperar filtros."
         },
         "attribute": "resource-i-d",
         "reflect": false
@@ -440,8 +481,14 @@ export class SnkPersonalizedFilter {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Define se o filtro em quest\u00E3o \u00E9 um filtro padr\u00E3o."
+          "tags": [{
+              "name": "property",
+              "text": undefined
+            }, {
+              "name": "default",
+              "text": "false"
+            }],
+          "text": "Indica se o filtro \u00E9 o filtro padr\u00E3o do sistema."
         },
         "attribute": "is-default-filter",
         "reflect": false,
@@ -463,8 +510,11 @@ export class SnkPersonalizedFilter {
         "cancelable": true,
         "composed": true,
         "docs": {
-          "tags": [],
-          "text": ""
+          "tags": [{
+              "name": "event",
+              "text": undefined
+            }],
+          "text": "Evento emitido ao cancelar a personaliza\u00E7\u00E3o do filtro."
         },
         "complexType": {
           "original": "void",
@@ -478,8 +528,11 @@ export class SnkPersonalizedFilter {
         "cancelable": true,
         "composed": true,
         "docs": {
-          "tags": [],
-          "text": ""
+          "tags": [{
+              "name": "event",
+              "text": undefined
+            }],
+          "text": "Evento emitido ao salvar as altera\u00E7\u00F5es do filtro personalizado."
         },
         "complexType": {
           "original": "string",
@@ -493,8 +546,11 @@ export class SnkPersonalizedFilter {
         "cancelable": true,
         "composed": true,
         "docs": {
-          "tags": [],
-          "text": ""
+          "tags": [{
+              "name": "event",
+              "text": undefined
+            }],
+          "text": "Evento emitido ap\u00F3s salvar as altera\u00E7\u00F5es do filtro personalizado."
         },
         "complexType": {
           "original": "void",
@@ -521,8 +577,14 @@ export class SnkPersonalizedFilter {
           "return": "Promise<void>"
         },
         "docs": {
-          "text": "",
-          "tags": []
+          "text": "Cria um novo filtro personalizado caso n\u00E3o exista nenhum.",
+          "tags": [{
+              "name": "method",
+              "text": undefined
+            }, {
+              "name": "returns",
+              "text": undefined
+            }]
         }
       }
     };

package/dist/collection/components/snk-simple-bar/snk-simple-bar.js

@@ -7,11 +7,11 @@ export class SnkSimpleBar {
     this.messagesBuilder = undefined;
   }
   /**
-   * 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-simple-bar.msg.ts"
-  */
+   * Permite customizar as mensagens dos blocos de construção
+   * através de um pequeno módulo na estrutura da aplicação:
+   * - Crie um arquivo no seguinte caminho: /messages/appmessages.msg.js.
+   * Para conhecer os detalhes do módulo, veja o arquivo neste projeto: "/src/lib/message/resources/snk-simple-bar.msg.ts"
+   */
   getMessage(key, params) {
     var _a;
     if (this.messagesBuilder)
@@ -54,7 +54,7 @@ export class SnkSimpleBar {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "Define o t\u00EDtulo do header"
+          "text": "Define o t\u00EDtulo do header."
         },
         "attribute": "label",
         "reflect": false
@@ -79,7 +79,7 @@ export class SnkSimpleBar {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "Define os itens que ser\u00E3o apresentados pelo breadcrumb"
+          "text": "Define os itens que ser\u00E3o apresentados no breadcrumb."
         }
       },
       "messagesBuilder": {
@@ -113,7 +113,7 @@ export class SnkSimpleBar {
         "composed": true,
         "docs": {
           "tags": [],
-          "text": "Emitido quando algum item do breadcrumb \u00E9 clicado"
+          "text": "Emitido quando algum item do breadcrumb \u00E9 clicado."
         },
         "complexType": {
           "original": "IBreadcrumbItem",
@@ -133,7 +133,7 @@ export class SnkSimpleBar {
         "composed": true,
         "docs": {
           "tags": [],
-          "text": "Emitido quando o bot\u00E3o voltar \u00E9 acionado"
+          "text": "Emitido quando o bot\u00E3o \"voltar\" \u00E9 acionado."
         },
         "complexType": {
           "original": "void",