@sankhyalabs/sankhyablocks 9.2.0-dev.9 → 9.2.0-ms.1

package/dist/cjs/snk-grid.cjs.entry.js

@@ -159,7 +159,6 @@ const SnkGrid = class {
     this.multipleEditionEnabled = true;
     this.paginationCounterMode = 'auto';
     this.suppressCheckboxColumn = undefined;
-    this.suppressFilterColumn = false;
     this.compact = undefined;
   }
   getGridHeaderSelectedBtns() {
@@ -172,18 +171,11 @@ const SnkGrid = class {
       btns.unshift(taskbarElements.TaskbarElement.UPDATE_MULTIPLE);
     return btns;
   }
-  /**
-   * Recarrega a configuração da grade.
-   * @description Este método força o recarregamento da configuração da grade a partir do `ConfigStorage`. A operação é assíncrona, mas o método não aguarda sua conclusão.
-   */
   reloadConfig() {
     this.loadConfig();
   }
   /**
    * Exibe a janela de configurações da grade.
-   * @async
-   * @description Este método abre o pop-up de configuração de colunas da grade, permitindo ao usuário ajustar a visibilidade, ordem e largura das colunas.
-   * @returns {Promise<void>} Uma promessa que é resolvida quando a janela de configuração é exibida.
    */
   async showConfig() {
     if (this._grid == undefined) {
@@ -193,9 +185,6 @@ const SnkGrid = class {
   }
   /**
    * Fecha a janela de configurações da grade.
-   * @async
-   * @description Este método fecha o pop-up de configuração de colunas da grade.
-   * @returns {Promise<void>} Uma promessa que é resolvida quando a janela de configuração é fechada.
    */
   async hideConfig() {
     if (this._grid == undefined) {
@@ -204,42 +193,26 @@ const SnkGrid = class {
     this.closeGridConfig();
   }
   /**
-   * Define a configuração da grade.
-   * @async
-   * @description Aplica uma nova configuração de colunas e ordenação à grade.
-   * @param {IGridConfig} config O objeto de configuração a ser aplicado na grade.
-   * @returns {Promise<void>} Uma promessa que é resolvida quando a configuração é aplicada.
+   * Atribui o valor da configuração da grade.
    */
   async setConfig(config) {
     this.setGridConfig(config);
   }
   /**
-   * Recarrega a barra de filtros da grade, buscando o estado do servidor.
-   * @async
-   * @description Força o recarregamento da barra de filtros, atualizando suas configurações e filtros a partir do servidor.
-   * @returns {Promise<void>} Uma promessa que é resolvida quando a barra de filtros é recarregada.
+   * Faz o recarregamento da filter-bar da grade buscando o state no servidor.
    */
   async reloadFilterBar() {
     var _a;
     (_a = this._snkFilterBar) === null || _a === void 0 ? void 0 : _a.reload();
   }
   /**
-   * Retorna o elemento da barra de filtros da grade.
-   * @async
-   * @description Este método permite acessar o elemento da barra de filtros, que pode ser útil para manipulações adicionais ou para obter o estado atual dos filtros aplicados.
-   * @returns {Promise<HTMLSnkFilterBarElement>} O elemento da barra de filtros.
+   * Retorna o elemento da filter-bar da grade.
    */
   async getFilterBar() {
     return this._snkFilterBar;
   }
   /**
-   * Registra um editor customizado para um campo da grade ou formulário.
-   * @async
-   * @description Adiciona um componente de edição personalizado para um campo específico. Este editor será usado tanto na edição em linha na grade quanto em formulários de detalhe.
-   * @param {string} fieldName O nome do campo que receberá o editor customizado.
-   * @param {ICustomEditor} customEditor A instância do editor customizado.
-   * @param {string} [detailContext] O contexto de detalhe onde o editor será aplicado (opcional).
-   * @returns {Promise<void>} Uma promessa que é resolvida quando o editor é registrado.
+   * Registra um editor customizado para campos da grade e formulário
    */
   async addCustomEditor(fieldName, customEditor, detailContext) {
     if (this._grid) {
@@ -251,13 +224,7 @@ const SnkGrid = class {
     this._customEditors = newCustomEditors;
   }
   /**
-   * Registra um renderizador customizado para uma coluna da grade.
-   * @async
-   * @description Adiciona um componente de renderização personalizado para uma coluna específica, permitindo a exibição de conteúdo customizado nas células.
-   * @param {string} fieldName O nome do campo (coluna) que receberá o renderizador customizado.
-   * @param {ICustomRender} customRender A instância do renderizador customizado.
-   * @param {string} [detailContext] O contexto de detalhe onde o renderizador será aplicado (opcional).
-   * @returns {Promise<void>} Uma promessa que é resolvida quando o renderizador é registrado.
+   * Registra um render customizado para colunas da grid.
    */
   async addGridCustomRender(fieldName, customRender, detailContext) {
     if (this._grid) {
@@ -269,31 +236,19 @@ const SnkGrid = class {
     this._customRenders = newCustomRenders;
   }
   /**
-   * Registra um formatador de valor customizado para uma coluna da grade.
-   * @async
-   * @description Adiciona uma função de formatação personalizada para os valores de uma coluna específica, afetando como os dados são exibidos.
-   * @param {string} columnName O nome da coluna que receberá o formatador.
-   * @param {ICustomFormatter} customFormatter A instância do formatador de valor.
-   * @returns {Promise<void>} Uma promessa que é resolvida quando o formatador é registrado.
+   * Registra um formatador de valores para uma coluna da grid.
    */
   async addCustomValueFormatter(columnName, customFormatter) {
     this._grid.addCustomValueFormatter(columnName, customFormatter);
   }
   /**
-   * Remove um formatador de valor customizado de uma coluna da grade.
-   * @async
-   * @description Remove uma função de formatação personalizada previamente registrada para uma coluna.
-   * @param {string} columnName O nome da coluna da qual o formatador será removido.
-   * @returns {Promise<void>} Uma promessa que é resolvida quando o formatador é removido.
+   * Remove o formatador de valores de uma coluna da grid.
    */
   async removeCustomValueFormatter(columnName) {
     this._grid.removeCustomValueFormatter(columnName);
   }
   /**
    * Atribui o foco para a grade.
-   * @async
-   * @description Move o foco do navegador para o componente da grade, permitindo a navegação por teclado.
-   * @returns {Promise<void>} Uma promessa que é resolvida quando o foco é atribuído.
    */
   async setFocus() {
     this._grid.setFocus();

package/dist/collection/components/snk-application/snk-application.js

@@ -867,11 +867,6 @@ export class SnkApplication {
   /**
    * Realiza a pesquisa de registros
    * Ex.: snk-config-options
-   * @param {string} mode - O modo da pesquisa ("ADVANCED" ou outro).
-   * @param {string} argument - O argumento da pesquisa.
-   * @param {any} options - Opções preparadas para a pesquisa.
-   * @returns {Promise<Array<IOption> | IOption>} Uma lista de opções ou uma única opção.
-   * @async
    */
   async executePreparedSearchPlus(mode, argument, options) {
     return await this.executePreparedSearch(mode, argument, Object.assign(Object.assign({}, options), { useSearchPlus: true }));
@@ -881,7 +876,7 @@ export class SnkApplication {
    * Ex.: snk-config-options
    * @param {string} mode - O modo da pesquisa ("ADVANCED" ou outro).
    * @param {string} argument - O argumento da pesquisa.
-   * @param {any} options - Opções preparadas para a pesquisa.
+   * @param {IPreparedSearchOptions} options - Opções preparadas para a pesquisa.
    * @returns {Promise<Array<IOption> | IOption>} Uma lista de opções ou uma única opção.
    * @async
    */
@@ -3363,6 +3358,9 @@ export class SnkApplication {
             "SearchCriteria": {
               "location": "import",
               "path": "../../lib/http/data-fetcher/fetchers/pesquisa-fetcher"
+            },
+            "IPreparedSearchOptions": {
+              "location": "local"
             }
           },
           "return": "Promise<IOption | IOption[]>"
@@ -3392,25 +3390,16 @@ export class SnkApplication {
       },
       "executePreparedSearchPlus": {
         "complexType": {
-          "signature": "(mode: string, argument: string, options: any) => Promise<Array<IOption> | IOption>",
+          "signature": "(mode: string, argument: string, options: IPreparedSearchOptions) => Promise<Array<IOption> | IOption>",
           "parameters": [{
-              "tags": [{
-                  "name": "param",
-                  "text": "mode - O modo da pesquisa (\"ADVANCED\" ou outro)."
-                }],
-              "text": "- O modo da pesquisa (\"ADVANCED\" ou outro)."
+              "tags": [],
+              "text": ""
             }, {
-              "tags": [{
-                  "name": "param",
-                  "text": "argument - O argumento da pesquisa."
-                }],
-              "text": "- O argumento da pesquisa."
+              "tags": [],
+              "text": ""
             }, {
-              "tags": [{
-                  "name": "param",
-                  "text": "options - Op\u00E7\u00F5es preparadas para a pesquisa."
-                }],
-              "text": "- Op\u00E7\u00F5es preparadas para a pesquisa."
+              "tags": [],
+              "text": ""
             }],
           "references": {
             "Promise": {
@@ -3420,6 +3409,9 @@ export class SnkApplication {
               "location": "import",
               "path": "@sankhyalabs/ezui/dist/types/components/ez-search/ez-search"
             },
+            "IPreparedSearchOptions": {
+              "location": "local"
+            },
             "Array": {
               "location": "global"
             }
@@ -3428,27 +3420,12 @@ export class SnkApplication {
         },
         "docs": {
           "text": "Realiza a pesquisa de registros\nEx.: snk-config-options",
-          "tags": [{
-              "name": "param",
-              "text": "mode - O modo da pesquisa (\"ADVANCED\" ou outro)."
-            }, {
-              "name": "param",
-              "text": "argument - O argumento da pesquisa."
-            }, {
-              "name": "param",
-              "text": "options - Op\u00E7\u00F5es preparadas para a pesquisa."
-            }, {
-              "name": "returns",
-              "text": "Uma lista de op\u00E7\u00F5es ou uma \u00FAnica op\u00E7\u00E3o."
-            }, {
-              "name": "async",
-              "text": undefined
-            }]
+          "tags": []
         }
       },
       "executePreparedSearch": {
         "complexType": {
-          "signature": "(mode: string, argument: string, options: any) => Promise<Array<IOption> | IOption>",
+          "signature": "(mode: string, argument: string, options: IPreparedSearchOptions) => Promise<Array<IOption> | IOption>",
           "parameters": [{
               "tags": [{
                   "name": "param",
@@ -3476,6 +3453,9 @@ export class SnkApplication {
               "location": "import",
               "path": "@sankhyalabs/ezui/dist/types/components/ez-search/ez-search"
             },
+            "IPreparedSearchOptions": {
+              "location": "local"
+            },
             "Array": {
               "location": "global"
             },

package/dist/collection/components/snk-data-unit/snk-data-unit.js

@@ -100,8 +100,6 @@ export class SnkDataUnit {
   }
   /**
    * Obtém o dataUnit.
-   * @returns {Promise<DataUnit>} Uma promessa que resolve com a instância do DataUnit.
-   * @async
    */
   async getDataUnit() {
     return new Promise((resolve) => {
@@ -115,33 +113,25 @@ export class SnkDataUnit {
   }
   /**
    * Método que retorna a lista de IDs dos registros selecionados.
-   * @returns {Promise<Array<IRecordID>>} Retorna uma promessa que resolve com a lista de IDs dos registros selecionados.
-   * @async
+   * @returns Retorna a lista de IDs dos registros selecionados.
    */
   async getSelectedRecordsIDsInfo() {
     return getSelectedRecordsIDsInfo(this.dataUnit);
   }
   /**
    * Retorna os campos que possuem a propriedade "rmp" (Row Metadata Provider).
-   * @returns {Promise<string[]>} Uma promessa que resolve com um array de nomes de campos.
-   * @async
    */
   async getFieldsWithRmp() {
     return this._fieldsWithRmp;
   }
   /**
    * Retorna os campos que possuem a propriedade "rm_precision" (Row Metadata Precision).
-   * @returns {Promise<string[]>} Uma promessa que resolve com um array de nomes de campos.
-   * @async
    */
   async getFieldsWithRmPrecision() {
     return this._fieldsWithRmPrecision;
   }
   /**
    * Busca os metadados da linha selecionada.
-   * @param {Record | string} [record] - O registro ou ID do registro para o qual buscar os metadados. Se omitido, usa o registro selecionado.
-   * @returns {Promise<RowMetadata>} Uma promessa que resolve com os metadados da linha.
-   * @async
    */
   async getRowMetadata(record) {
     return this.doGetRowMetadata(record);
@@ -783,10 +773,7 @@ export class SnkDataUnit {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [{
-              "name": "type",
-              "text": "{DataState}"
-            }],
+          "tags": [],
           "text": "Controla o estado atual dos dados."
         }
       },
@@ -806,10 +793,7 @@ export class SnkDataUnit {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [{
-              "name": "type",
-              "text": "{SnkMessageBuilder}"
-            }],
+          "tags": [],
           "text": "Respons\u00E1vel por flexibilizar e padronizar o uso de mensagens nos blocos de constru\u00E7\u00E3o."
         }
       },
@@ -824,10 +808,7 @@ export class SnkDataUnit {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [{
-              "name": "type",
-              "text": "{string}"
-            }],
+          "tags": [],
           "text": "Usado para criar o dataUnit uma \u00FAnica vez.\nSe omitido, ser\u00E1 usado o pr\u00F3prio nome da entidade."
         },
         "attribute": "data-unit-name",
@@ -844,10 +825,7 @@ export class SnkDataUnit {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [{
-              "name": "type",
-              "text": "{string}"
-            }],
+          "tags": [],
           "text": "Determina qual a entidade que representa os dados em quest\u00E3o."
         },
         "attribute": "entity-name",
@@ -864,13 +842,7 @@ export class SnkDataUnit {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [{
-              "name": "type",
-              "text": "{number}"
-            }, {
-              "name": "default",
-              "text": "150"
-            }],
+          "tags": [],
           "text": "Determina quantas linhas s\u00E3o retornadas por p\u00E1gina."
         },
         "attribute": "page-size",
@@ -893,10 +865,7 @@ export class SnkDataUnit {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [{
-              "name": "type",
-              "text": "{DataUnit}"
-            }],
+          "tags": [],
           "text": "Uma vez instanciado, pode-se obter o dataUnit por esta propriedade."
         }
       },
@@ -919,13 +888,7 @@ export class SnkDataUnit {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [{
-              "name": "param",
-              "text": "dataUnit - A inst\u00E2ncia do DataUnit."
-            }, {
-              "name": "returns",
-              "text": "`false` para cancelar a a\u00E7\u00E3o, `true` para continuar."
-            }],
+          "tags": [],
           "text": "Executado imediatamente antes da a\u00E7\u00E3o de salvar as altera\u00E7\u00F5es. \u00DAtil no caso de valida\u00E7\u00F5es por exemplo.\nCaso retorne \"false\" (ou a promessa se resolva como false), cancela a a\u00E7\u00E3o."
         }
       },
@@ -945,13 +908,7 @@ export class SnkDataUnit {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [{
-              "name": "param",
-              "text": "dataUnit - A inst\u00E2ncia do DataUnit."
-            }, {
-              "name": "returns",
-              "text": undefined
-            }],
+          "tags": [],
           "text": "Executado ap\u00F3s a a\u00E7\u00E3o de salvar."
         }
       },
@@ -966,13 +923,7 @@ export class SnkDataUnit {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [{
-              "name": "type",
-              "text": "{boolean}"
-            }, {
-              "name": "default",
-              "text": "true"
-            }],
+          "tags": [],
           "text": "Determina se ser\u00E1 usado mensagem de confirma\u00E7\u00E3o padr\u00E3o na tentativa de cancelar a edi\u00E7\u00E3o."
         },
         "attribute": "use-cancel-confirm",
@@ -990,10 +941,7 @@ export class SnkDataUnit {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [{
-              "name": "type",
-              "text": "{boolean}"
-            }],
+          "tags": [],
           "text": "Respons\u00E1vel por evitar a mensagem de sucesso ao salvar."
         },
         "attribute": "ignore-save-message",
@@ -1010,10 +958,7 @@ export class SnkDataUnit {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [{
-              "name": "type",
-              "text": "{string}"
-            }],
+          "tags": [],
           "text": "Usado para obter configura\u00E7\u00E3o de metadados."
         },
         "attribute": "config-name",
@@ -1030,10 +975,7 @@ export class SnkDataUnit {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [{
-              "name": "type",
-              "text": "{string}"
-            }],
+          "tags": [],
           "text": "Identificador de recursos como configura\u00E7\u00F5es e acesso."
         },
         "attribute": "resource-i-d",
@@ -1050,10 +992,7 @@ export class SnkDataUnit {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [{
-              "name": "type",
-              "text": "{string}"
-            }],
+          "tags": [],
           "text": "Define a chave customizada para sobrescrever as mensagens (N\u00E3o pegando pela entidade)"
         },
         "attribute": "domain-messages-builder",
@@ -1074,16 +1013,7 @@ export class SnkDataUnit {
         "cancelable": true,
         "composed": true,
         "docs": {
-          "tags": [{
-              "name": "event",
-              "text": "dataStateChange"
-            }, {
-              "name": "type",
-              "text": "{CustomEvent<DataState>}"
-            }, {
-              "name": "bubbles",
-              "text": "false"
-            }],
+          "tags": [],
           "text": "Emitido quando h\u00E1 qualquer mudan\u00E7a de estado no DataUnit."
         },
         "complexType": {
@@ -1102,16 +1032,7 @@ export class SnkDataUnit {
         "cancelable": true,
         "composed": true,
         "docs": {
-          "tags": [{
-              "name": "event",
-              "text": "dataUnitReady"
-            }, {
-              "name": "type",
-              "text": "{CustomEvent<DataUnit>}"
-            }, {
-              "name": "bubbles",
-              "text": "false"
-            }],
+          "tags": [],
           "text": "Emitido quando o DataUnit est\u00E1 pronto."
         },
         "complexType": {
@@ -1131,17 +1052,8 @@ export class SnkDataUnit {
         "cancelable": true,
         "composed": true,
         "docs": {
-          "tags": [{
-              "name": "event",
-              "text": "messagesBuilderUpdated"
-            }, {
-              "name": "type",
-              "text": "{CustomEvent<SnkMessageBuilder>}"
-            }, {
-              "name": "bubbles",
-              "text": "false"
-            }],
-          "text": "Emitido quando o messagesBuilder \u00E9 atualizado."
+          "tags": [],
+          "text": "Emitido quando o DataUnit est\u00E1 pronto."
         },
         "complexType": {
           "original": "SnkMessageBuilder",
@@ -1160,13 +1072,7 @@ export class SnkDataUnit {
         "cancelable": true,
         "composed": true,
         "docs": {
-          "tags": [{
-              "name": "event",
-              "text": "dataUnitFieldsHidded"
-            }, {
-              "name": "type",
-              "text": "{CustomEvent<void>}"
-            }],
+          "tags": [],
           "text": "Emitido quando h\u00E1 campos no DataUnit que devem ser ocultados."
         },
         "complexType": {
@@ -1181,16 +1087,7 @@ export class SnkDataUnit {
         "cancelable": true,
         "composed": true,
         "docs": {
-          "tags": [{
-              "name": "event",
-              "text": "insertionMode"
-            }, {
-              "name": "type",
-              "text": "{CustomEvent<void>}"
-            }, {
-              "name": "bubbles",
-              "text": "false"
-            }],
+          "tags": [],
           "text": "Emitido quando um registro \u00E9 adicionado ou copiado."
         },
         "complexType": {
@@ -1205,16 +1102,7 @@ export class SnkDataUnit {
         "cancelable": true,
         "composed": true,
         "docs": {
-          "tags": [{
-              "name": "event",
-              "text": "cancelEdition"
-            }, {
-              "name": "type",
-              "text": "{CustomEvent<void>}"
-            }, {
-              "name": "bubbles",
-              "text": "false"
-            }],
+          "tags": [],
           "text": "Emitido quando se cancela uma inser\u00E7\u00E3o ou c\u00F3pia."
         },
         "complexType": {
@@ -1243,13 +1131,7 @@ export class SnkDataUnit {
         },
         "docs": {
           "text": "Obt\u00E9m o dataUnit.",
-          "tags": [{
-              "name": "returns",
-              "text": "Uma promessa que resolve com a inst\u00E2ncia do DataUnit."
-            }, {
-              "name": "async",
-              "text": undefined
-            }]
+          "tags": []
         }
       },
       "getSelectedRecordsIDsInfo": {
@@ -1274,10 +1156,7 @@ export class SnkDataUnit {
           "text": "M\u00E9todo que retorna a lista de IDs dos registros selecionados.",
           "tags": [{
               "name": "returns",
-              "text": "Retorna uma promessa que resolve com a lista de IDs dos registros selecionados."
-            }, {
-              "name": "async",
-              "text": undefined
+              "text": "Retorna a lista de IDs dos registros selecionados."
             }]
         }
       },
@@ -1294,13 +1173,7 @@ export class SnkDataUnit {
         },
         "docs": {
           "text": "Retorna os campos que possuem a propriedade \"rmp\" (Row Metadata Provider).",
-          "tags": [{
-              "name": "returns",
-              "text": "Uma promessa que resolve com um array de nomes de campos."
-            }, {
-              "name": "async",
-              "text": undefined
-            }]
+          "tags": []
         }
       },
       "getFieldsWithRmPrecision": {
@@ -1316,24 +1189,15 @@ export class SnkDataUnit {
         },
         "docs": {
           "text": "Retorna os campos que possuem a propriedade \"rm_precision\" (Row Metadata Precision).",
-          "tags": [{
-              "name": "returns",
-              "text": "Uma promessa que resolve com um array de nomes de campos."
-            }, {
-              "name": "async",
-              "text": undefined
-            }]
+          "tags": []
         }
       },
       "getRowMetadata": {
         "complexType": {
           "signature": "(record?: Record | string) => Promise<RowMetadata>",
           "parameters": [{
-              "tags": [{
-                  "name": "param",
-                  "text": "record - O registro ou ID do registro para o qual buscar os metadados. Se omitido, usa o registro selecionado."
-                }],
-              "text": "- O registro ou ID do registro para o qual buscar os metadados. Se omitido, usa o registro selecionado."
+              "tags": [],
+              "text": ""
             }],
           "references": {
             "Promise": {
@@ -1351,16 +1215,7 @@ export class SnkDataUnit {
         },
         "docs": {
           "text": "Busca os metadados da linha selecionada.",
-          "tags": [{
-              "name": "param",
-              "text": "record - O registro ou ID do registro para o qual buscar os metadados. Se omitido, usa o registro selecionado."
-            }, {
-              "name": "returns",
-              "text": "Uma promessa que resolve com os metadados da linha."
-            }, {
-              "name": "async",
-              "text": undefined
-            }]
+          "tags": []
         }
       }
     };