@sankhyalabs/sankhyablocks 9.1.8-rc.3 → 9.1.8

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

@@ -94,28 +94,22 @@ export class SnkFilterBar {
     this.processAfterUpdateConfig();
   }
   /**
-   * @description Faz o recarregamento da barra de filtros buscando o state no servidor.
-   * @async
-   * @return {Promise<void>} Retorna uma Promise que resolve quando o recarregamento for concluído.
+   * Faz o recarregamento da filterbar buscando o state no servidor.
    */
   async reload() {
     this.loadConfigFromStorage(true);
   }
   /**
-   * @description Retorna um item de filtro pelo ID.
-   * @async
-   * @param {string} id - ID do item de filtro.
-   * @returns {Promise<SnkFilterItemConfig | undefined>} O item de filtro correspondente ou undefined se não for encontrado.
+   * Retorna um item de filtro pelo ID.
    */
   async getFilterItem(id) {
     const item = this.filterConfig.find(item => item.id === id);
     return Promise.resolve(ObjectUtils.copy(item));
   }
   /**
-  * @description Atualiza um item do filtro.
-  * @async
-  * @param {SnkFilterItemConfig} newFilterItem - Item com as informações atualizadas, caso o item não seja encontrado no array, ele não será modificado.
-  * @return {Promise<void>} Retorna uma Promise que resolve quando a atualização for concluída.
+  * Atualiza um item do filtro.
+  *
+  * @param filterItem - Item com as informações atualizadas, caso o item não seja encontrado no array ele mão será modificado
   */
   async updateFilterItem(newFilterItem) {
     const itemIndex = this.filterConfig.findIndex(item => item.id === newFilterItem.id);
@@ -128,10 +122,9 @@ export class SnkFilterBar {
     return Promise.resolve();
   }
   /**
-  * @description Adiciona um item de filtro.
-  * @async
-  * @param {SnkFilterItemConfig} filterItem - Item a ser adicionado, caso o item já exista com o ID, ele não será adicionado novamente.
-  * @return {Promise<void>} Retorna uma Promise que resolve quando o item for adicionado.
+  * Adiciona um item de filtro.
+  *
+  * @param filterItem - Item a ser adicionado, caso o item já exista com o ID ele não será adicionado novamente
   */
   async addFilterItem(filterItem) {
     const itemIndex = this.filterConfig.findIndex(item => item.id === filterItem.id);
@@ -145,10 +138,11 @@ export class SnkFilterBar {
     return Promise.resolve();
   }
   /**
-  * @description Remove um item de filtro.
-  * @async
-  * @param {string} filterID - ID do item a ser removido.
-  * @returns {Promise<SnkFilterItemConfig|undefined>} Retorna o item de filtro removido, ou undefined caso não seja encontrado.
+  * Remove um item de filtro.
+  *
+  * @param filterID - ID do a ser adicionado
+  *
+  * @returns {Promise<SnkFilterItemConfig|undefined>} - Retorna o item de filtro removido, ou undefined caso não encontrado.
   */
   async removeFilterItem(filterID) {
     const itemIndex = this.filterConfig.findIndex(item => item.id === filterID);
@@ -221,7 +215,7 @@ export class SnkFilterBar {
   }
   /**
    * Conforme mecanismo de mensagens, é possível customizar as mensagens dos blocos de construção
-   * através de um pequeno módulo na estrutura da aplicaçã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"
    */
@@ -400,8 +394,7 @@ export class SnkFilterBar {
     this.updateFilter(evt.detail);
   }
   /**
-   * @description Abre o modal de filtros.
-   * @async
+   * Abre o modal de filtros
   */
   async showFilterModal() {
     const callbackOnApplyFilter = (filters) => {
@@ -527,11 +520,8 @@ export class SnkFilterBar {
         "required": false,
         "optional": true,
         "docs": {
-          "tags": [{
-              "name": "description",
-              "text": "Define se o componente deve usar o LockManager para controle de carregamento."
-            }],
-          "text": ""
+          "tags": [],
+          "text": "Define se o componente deve usar o LockManager para controle de carregamento"
         },
         "attribute": "enable-lock-manager-loading-comp",
         "reflect": false,
@@ -559,23 +549,8 @@ export class SnkFilterBar {
         "required": false,
         "optional": true,
         "docs": {
-          "tags": [{
-              "name": "description",
-              "text": "Loader customizado para carregar as configura\u00E7\u00F5es."
-            }, {
-              "name": "param",
-              "text": "configName - Nome da configura\u00E7\u00E3o."
-            }, {
-              "name": "param",
-              "text": "resourceId - ID do recurso."
-            }, {
-              "name": "param",
-              "text": "options - Op\u00E7\u00F5es adicionais."
-            }, {
-              "name": "returns",
-              "text": "Retorna a configura\u00E7\u00E3o dos filtros."
-            }],
-          "text": ""
+          "tags": [],
+          "text": "Loader customizado para carregar as configura\u00E7\u00F5es"
         }
       },
       "dataUnit": {
@@ -594,11 +569,8 @@ export class SnkFilterBar {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [{
-              "name": "description",
-              "text": "Recebe o DataUnit do ambiente. Se n\u00E3o for informado, procura pela refer\u00EAncia\ndo SnkDataUnit. Necess\u00E1rio para se registrar como provedor de filtros."
-            }],
-          "text": ""
+          "tags": [],
+          "text": "Recebe o DataUnit do ambiente. Se n\u00E3o for informado, procura pela refer\u00EAncia\ndo SnkDataUnit. Necess\u00E1rio para se registrar como provedor de filtros."
         }
       },
       "title": {
@@ -612,11 +584,8 @@ export class SnkFilterBar {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [{
-              "name": "description",
-              "text": "T\u00EDtulo que ser\u00E1 apresentado na barra de filtros."
-            }],
-          "text": ""
+          "tags": [],
+          "text": "T\u00EDtulo que ser\u00E1 apresentado na barra de filtros"
         },
         "attribute": "title",
         "reflect": false
@@ -632,11 +601,8 @@ export class SnkFilterBar {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [{
-              "name": "description",
-              "text": "Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade\nserve para separar a configura\u00E7\u00E3o de cada uma."
-            }],
-          "text": ""
+          "tags": [],
+          "text": "Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade\nserve para separar a configura\u00E7\u00E3o de cada uma."
         },
         "attribute": "config-name",
         "reflect": false
@@ -652,11 +618,8 @@ export class SnkFilterBar {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [{
-              "name": "description",
-              "text": "Identificador de recursos como configura\u00E7\u00F5es e acesso."
-            }],
-          "text": ""
+          "tags": [],
+          "text": "Identificador de recursos como configura\u00E7\u00F5es e acesso."
         },
         "attribute": "resource-i-d",
         "reflect": false
@@ -672,11 +635,8 @@ export class SnkFilterBar {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [{
-              "name": "description",
-              "text": "Modo de apresenta\u00E7\u00E3o da barra de filtros."
-            }],
-          "text": ""
+          "tags": [],
+          "text": "Modo de apresenta\u00E7\u00E3o da filterbar."
         },
         "attribute": "mode",
         "reflect": false,
@@ -701,11 +661,8 @@ export class SnkFilterBar {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [{
-              "name": "description",
-              "text": "Lista todos os filtros dispon\u00EDveis ao usu\u00E1rio."
-            }],
-          "text": ""
+          "tags": [],
+          "text": "Lista todos os filtros dispon\u00EDveis ao usu\u00E1rio."
         }
       },
       "messagesBuilder": {
@@ -724,11 +681,8 @@ export class SnkFilterBar {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [{
-              "name": "description",
-              "text": "Respons\u00E1vel por flexibilizar e padronizar o uso de mensagens nos blocos de constru\u00E7\u00E3o."
-            }],
-          "text": ""
+          "tags": [],
+          "text": "Respons\u00E1vel por flexibilizar e padronizar o uso de mensagens nos blocos de constru\u00E7\u00E3o."
         }
       },
       "disablePersonalizedFilter": {
@@ -742,11 +696,8 @@ export class SnkFilterBar {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [{
-              "name": "description",
-              "text": "Desabilita a apresenta\u00E7\u00E3o da op\u00E7\u00E3o de filtros personalizados na filter bar (chip de filtros)\ne no modal lateral de filtros (container de filtros personalizados)."
-            }],
-          "text": ""
+          "tags": [],
+          "text": "Desabilita a apresenta\u00E7\u00E3o da op\u00E7\u00E3o de filtros personalizados na filter bar (chip de filtros)\ne no modal lateral de filtros (container de filtros personalizados)."
         },
         "attribute": "disable-personalized-filter",
         "reflect": false
@@ -762,11 +713,8 @@ export class SnkFilterBar {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [{
-              "name": "description",
-              "text": "Chave da configura\u00E7\u00E3o legada da barra de filtros."
-            }],
-          "text": ""
+          "tags": [],
+          "text": "Chave da configura\u00E7\u00E3o legado da barra de filtros."
         },
         "attribute": "filter-bar-legacy-config-name",
         "reflect": false
@@ -782,11 +730,8 @@ export class SnkFilterBar {
         "required": false,
         "optional": true,
         "docs": {
-          "tags": [{
-              "name": "description",
-              "text": "Define se a carga dos dados ser\u00E1 feita assim que o componente for carregado."
-            }],
-          "text": ""
+          "tags": [],
+          "text": "Define se a carga dos dados ser\u00E1 feita assim que o componente for carregado."
         },
         "attribute": "auto-load",
         "reflect": false
@@ -802,11 +747,8 @@ export class SnkFilterBar {
         "required": false,
         "optional": true,
         "docs": {
-          "tags": [{
-              "name": "description",
-              "text": "Fun\u00E7\u00E3o chamada depois de aplicar os filtros."
-            }],
-          "text": ""
+          "tags": [],
+          "text": "Fun\u00E7\u00E3o chamada depois de aplicar os filtros."
         }
       }
     };
@@ -827,16 +769,7 @@ export class SnkFilterBar {
         "cancelable": true,
         "composed": true,
         "docs": {
-          "tags": [{
-              "name": "description",
-              "text": "Evento emitido quando a configura\u00E7\u00E3o dos filtros \u00E9 atualizada."
-            }, {
-              "name": "param",
-              "text": "configs - Lista de configura\u00E7\u00F5es de filtros atualizadas."
-            }, {
-              "name": "event",
-              "text": undefined
-            }],
+          "tags": [],
           "text": ""
         },
         "complexType": {
@@ -865,28 +798,16 @@ export class SnkFilterBar {
           "return": "Promise<void>"
         },
         "docs": {
-          "text": "",
-          "tags": [{
-              "name": "description",
-              "text": "Faz o recarregamento da barra de filtros buscando o state no servidor."
-            }, {
-              "name": "async",
-              "text": undefined
-            }, {
-              "name": "return",
-              "text": "Retorna uma Promise que resolve quando o recarregamento for conclu\u00EDdo."
-            }]
+          "text": "Faz o recarregamento da filterbar buscando o state no servidor.",
+          "tags": []
         }
       },
       "getFilterItem": {
         "complexType": {
           "signature": "(id: string) => Promise<SnkFilterItemConfig | undefined>",
           "parameters": [{
-              "tags": [{
-                  "name": "param",
-                  "text": "id - ID do item de filtro."
-                }],
-              "text": "- ID do item de filtro."
+              "tags": [],
+              "text": ""
             }],
           "references": {
             "Promise": {
@@ -900,31 +821,16 @@ export class SnkFilterBar {
           "return": "Promise<SnkFilterItemConfig>"
         },
         "docs": {
-          "text": "",
-          "tags": [{
-              "name": "description",
-              "text": "Retorna um item de filtro pelo ID."
-            }, {
-              "name": "async",
-              "text": undefined
-            }, {
-              "name": "param",
-              "text": "id - ID do item de filtro."
-            }, {
-              "name": "returns",
-              "text": "O item de filtro correspondente ou undefined se n\u00E3o for encontrado."
-            }]
+          "text": "Retorna um item de filtro pelo ID.",
+          "tags": []
         }
       },
       "updateFilterItem": {
         "complexType": {
           "signature": "(newFilterItem: SnkFilterItemConfig) => Promise<void>",
           "parameters": [{
-              "tags": [{
-                  "name": "param",
-                  "text": "newFilterItem - Item com as informa\u00E7\u00F5es atualizadas, caso o item n\u00E3o seja encontrado no array, ele n\u00E3o ser\u00E1 modificado."
-                }],
-              "text": "- Item com as informa\u00E7\u00F5es atualizadas, caso o item n\u00E3o seja encontrado no array, ele n\u00E3o ser\u00E1 modificado."
+              "tags": [],
+              "text": ""
             }],
           "references": {
             "Promise": {
@@ -938,19 +844,10 @@ export class SnkFilterBar {
           "return": "Promise<void>"
         },
         "docs": {
-          "text": "",
+          "text": "Atualiza um item do filtro.",
           "tags": [{
-              "name": "description",
-              "text": "Atualiza um item do filtro."
-            }, {
-              "name": "async",
-              "text": undefined
-            }, {
               "name": "param",
-              "text": "newFilterItem - Item com as informa\u00E7\u00F5es atualizadas, caso o item n\u00E3o seja encontrado no array, ele n\u00E3o ser\u00E1 modificado."
-            }, {
-              "name": "return",
-              "text": "Retorna uma Promise que resolve quando a atualiza\u00E7\u00E3o for conclu\u00EDda."
+              "text": "filterItem - Item com as informa\u00E7\u00F5es atualizadas, caso o item n\u00E3o seja encontrado no array ele m\u00E3o ser\u00E1 modificado"
             }]
         }
       },
@@ -960,9 +857,9 @@ export class SnkFilterBar {
           "parameters": [{
               "tags": [{
                   "name": "param",
-                  "text": "filterItem - Item a ser adicionado, caso o item j\u00E1 exista com o ID, ele n\u00E3o ser\u00E1 adicionado novamente."
+                  "text": "filterItem - Item a ser adicionado, caso o item j\u00E1 exista com o ID ele n\u00E3o ser\u00E1 adicionado novamente"
                 }],
-              "text": "- Item a ser adicionado, caso o item j\u00E1 exista com o ID, ele n\u00E3o ser\u00E1 adicionado novamente."
+              "text": "- Item a ser adicionado, caso o item j\u00E1 exista com o ID ele n\u00E3o ser\u00E1 adicionado novamente"
             }],
           "references": {
             "Promise": {
@@ -976,19 +873,10 @@ export class SnkFilterBar {
           "return": "Promise<void>"
         },
         "docs": {
-          "text": "",
+          "text": "Adiciona um item de filtro.",
           "tags": [{
-              "name": "description",
-              "text": "Adiciona um item de filtro."
-            }, {
-              "name": "async",
-              "text": undefined
-            }, {
               "name": "param",
-              "text": "filterItem - Item a ser adicionado, caso o item j\u00E1 exista com o ID, ele n\u00E3o ser\u00E1 adicionado novamente."
-            }, {
-              "name": "return",
-              "text": "Retorna uma Promise que resolve quando o item for adicionado."
+              "text": "filterItem - Item a ser adicionado, caso o item j\u00E1 exista com o ID ele n\u00E3o ser\u00E1 adicionado novamente"
             }]
         }
       },
@@ -998,9 +886,9 @@ export class SnkFilterBar {
           "parameters": [{
               "tags": [{
                   "name": "param",
-                  "text": "filterID - ID do item a ser removido."
+                  "text": "filterID - ID do a ser adicionado"
                 }],
-              "text": "- ID do item a ser removido."
+              "text": "- ID do a ser adicionado"
             }],
           "references": {
             "Promise": {
@@ -1014,19 +902,13 @@ export class SnkFilterBar {
           "return": "Promise<SnkFilterItemConfig>"
         },
         "docs": {
-          "text": "",
+          "text": "Remove um item de filtro.",
           "tags": [{
-              "name": "description",
-              "text": "Remove um item de filtro."
-            }, {
-              "name": "async",
-              "text": undefined
-            }, {
               "name": "param",
-              "text": "filterID - ID do item a ser removido."
+              "text": "filterID - ID do a ser adicionado"
             }, {
               "name": "returns",
-              "text": "Retorna o item de filtro removido, ou undefined caso n\u00E3o seja encontrado."
+              "text": "- Retorna o item de filtro removido, ou undefined caso n\u00E3o encontrado."
             }]
         }
       },
@@ -1057,14 +939,8 @@ export class SnkFilterBar {
           "return": "Promise<void>"
         },
         "docs": {
-          "text": "",
-          "tags": [{
-              "name": "description",
-              "text": "Abre o modal de filtros."
-            }, {
-              "name": "async",
-              "text": undefined
-            }]
+          "text": "Abre o modal de filtros",
+          "tags": []
         }
       }
     };