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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. package/dist/cjs/loader.cjs.js +1 -1
  2. package/dist/cjs/sankhyablocks.cjs.js +1 -1
  3. package/dist/cjs/snk-application.cjs.entry.js +6 -4
  4. package/dist/cjs/snk-data-exporter.cjs.entry.js +1 -1
  5. package/dist/cjs/{snk-data-unit-448fce74.js → snk-data-unit-72715da9.js} +11 -1
  6. package/dist/cjs/snk-data-unit.cjs.entry.js +1 -1
  7. package/dist/cjs/snk-filter-bar_4.cjs.entry.js +22 -15
  8. package/dist/cjs/snk-form_2.cjs.entry.js +27 -1
  9. package/dist/cjs/snk-grid.cjs.entry.js +52 -7
  10. package/dist/collection/components/snk-application/snk-application.js +39 -21
  11. package/dist/collection/components/snk-data-unit/snk-data-unit.js +173 -28
  12. package/dist/collection/components/snk-filter-bar/snk-filter-bar.js +187 -63
  13. package/dist/collection/components/snk-form/snk-form.js +133 -22
  14. package/dist/collection/components/snk-grid/snk-grid.js +314 -83
  15. package/dist/collection/components/snk-taskbar/snk-taskbar.js +102 -36
  16. package/dist/components/snk-application2.js +6 -4
  17. package/dist/components/snk-data-unit2.js +11 -1
  18. package/dist/components/snk-filter-bar2.js +22 -15
  19. package/dist/components/snk-form.js +29 -2
  20. package/dist/components/snk-grid2.js +53 -7
  21. package/dist/esm/loader.js +1 -1
  22. package/dist/esm/sankhyablocks.js +1 -1
  23. package/dist/esm/snk-application.entry.js +6 -4
  24. package/dist/esm/snk-data-exporter.entry.js +1 -1
  25. package/dist/esm/{snk-data-unit-b7e6e7a6.js → snk-data-unit-d31619fb.js} +11 -1
  26. package/dist/esm/snk-data-unit.entry.js +1 -1
  27. package/dist/esm/snk-filter-bar_4.entry.js +22 -15
  28. package/dist/esm/snk-form_2.entry.js +27 -1
  29. package/dist/esm/snk-grid.entry.js +52 -7
  30. package/dist/sankhyablocks/p-49436976.entry.js +1 -0
  31. package/dist/sankhyablocks/p-665dd170.entry.js +11 -0
  32. package/dist/sankhyablocks/{p-8d1508aa.entry.js → p-69b815ab.entry.js} +1 -1
  33. package/dist/sankhyablocks/p-6fa3d474.entry.js +1 -0
  34. package/dist/sankhyablocks/{p-158adf33.entry.js → p-a2e8c7a7.entry.js} +1 -1
  35. package/dist/sankhyablocks/sankhyablocks.esm.js +1 -1
  36. package/dist/types/components/snk-application/search-strategy/exec-prepared-search-plus.d.ts +2 -2
  37. package/dist/types/components/snk-application/snk-application.d.ts +9 -14
  38. package/dist/types/components/snk-data-unit/snk-data-unit.d.ts +46 -3
  39. package/dist/types/components/snk-filter-bar/snk-filter-bar.d.ts +44 -28
  40. package/dist/types/components/snk-form/snk-form.d.ts +29 -4
  41. package/dist/types/components/snk-grid/snk-grid.d.ts +103 -45
  42. package/dist/types/components/snk-taskbar/snk-taskbar.d.ts +23 -21
  43. package/dist/types/components.d.ts +330 -151
  44. package/package.json +4 -3
  45. package/dist/collection/lib/licenses/sankhyalicense.module.js +0 -1
  46. package/dist/sankhyablocks/p-81769310.entry.js +0 -11
  47. package/dist/sankhyablocks/p-a86eee47.entry.js +0 -1
  48. package/dist/sankhyablocks/p-fa18530e.entry.js +0 -1
  49. /package/dist/sankhyablocks/{p-0e495575.js → p-8b601472.js} +0 -0
@@ -44,9 +44,12 @@ export declare class SnkGrid {
44
44
  _showSnkFilterBar: boolean;
45
45
  _enableContinuousInsert: boolean;
46
46
  _application: SnkApplication;
47
+ /**
48
+ * Define o data source para o filtro de colunas.
49
+ */
47
50
  columnFilterDataSource: IMultiSelectionListDataSource;
48
51
  /**
49
- * Define se o componente deve usar o LockManager para controle de carregamento da aplicação
52
+ * Define se o componente deve usar o LockManager para controle de carregamento da aplicação.
50
53
  */
51
54
  enableLockManagerLoadingComp?: boolean;
52
55
  /**
@@ -54,45 +57,48 @@ export declare class SnkGrid {
54
57
  */
55
58
  enableLockManagerTaskbarClick?: boolean;
56
59
  /**
57
- * Nome usado para salvar/recuperar a configuração.
60
+ * Nome usado para salvar e recuperar a configuração da grade.
58
61
  */
59
62
  configName: string;
60
63
  /**
61
- * Título que será apresentado na barra de filtros
64
+ * Título que será apresentado na barra de filtros.
62
65
  */
63
66
  filterBarTitle: string;
64
67
  /**
65
- * Identificador de recursos como configurações e acesso.
68
+ * Identificador de recursos, como configurações e permissões de acesso.
66
69
  */
67
70
  resourceID: string;
68
71
  /**
69
- * Configuração da seleção de grade no toast.
72
+ * Configuração do toast de seleção da grade.
70
73
  */
71
74
  selectionToastConfig: ISelectionToastConfig;
72
75
  /**
73
- * Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
76
+ * Lista de ações que devem ser usadas no botão "Mais opções" do `snk-taskbar`.
74
77
  */
75
78
  actionsList: Array<Action>;
76
79
  /**
77
- * Determina se a grade está vinculada a um detalhe.
80
+ * Determina se a grade está vinculada a um detalhe de outra tela.
78
81
  */
79
82
  isDetail: boolean;
80
83
  /**
81
- * Gerenciador das barras de tarefas. É possível determinar botões específicos
82
- * ou mesmo gerenciar o estado dos botões.
84
+ * Gerenciador das barras de tarefas. Permite determinar botões específicos
85
+ * ou gerenciar o estado dos botões.
83
86
  */
84
87
  taskbarManager: TaskbarManager;
85
88
  /**
86
- * Configuração do valor da coluna de status.
87
- * Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }'
89
+ * Define a configuração de cores para a coluna de status.
90
+ * @example
91
+ * ```json
92
+ * '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }'
93
+ * ```
88
94
  */
89
95
  statusResolver: IStatusResolver | StatusResolverFunction;
90
96
  /**
91
- * Determina se pode haver mais de uma linha selecionada.
97
+ * Determina se a seleção de múltiplas linhas é permitida.
92
98
  */
93
99
  multipleSelection: boolean;
94
100
  /**
95
- * Altera o modo de apresentação dos botões do snk-taskbar.
101
+ * Altera o modo de apresentação dos botões do `snk-taskbar`.
96
102
  */
97
103
  presentationMode: PresentationMode;
98
104
  /**
@@ -100,139 +106,191 @@ export declare class SnkGrid {
100
106
  */
101
107
  messagesBuilder: SnkMessageBuilder;
102
108
  /**
103
- * Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade.
109
+ * Quando `true`, a tecla ENTER navega entre as células como a tecla TAB.
104
110
  */
105
111
  useEnterLikeTab: boolean;
106
112
  /**
107
- * Validador responsável por checar a integridade das informações do registro.
113
+ * Validador responsável por verificar a integridade dos dados de um registro.
108
114
  */
109
115
  recordsValidator: IRecordValidator;
110
116
  /**
111
- * Define se a edição está habilitada na grid.
117
+ * Define se a edição de dados na grade está habilitada.
112
118
  */
113
119
  canEdit: boolean;
114
120
  /**
115
- * Define o identificador do container de elementos customizados da Taskbar.
121
+ * Define o identificador do contêiner de elementos customizados da `Taskbar`.
116
122
  */
117
123
  taskbarCustomContainerId: string;
118
124
  /**
119
- * Nome do slot de elementos customizados da Taskbar do cabeçalho da grade.
125
+ * Define o nome do slot para elementos customizados na `Taskbar` do cabeçalho da grade.
120
126
  */
121
127
  gridHeaderCustomSlotId: string;
122
128
  /**
123
- * Nome do slot de elementos customizados da Taskbar principal do componente.
129
+ * Define o nome do slot para elementos customizados na `Taskbar` principal do componente.
124
130
  */
125
131
  topTaskbarCustomSlotId: string;
126
132
  /**
127
- * Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros)
128
- * e no modal lateral de filtros (container de filtros personalizados).
133
+ * Desabilita a apresentação da opção de filtros personalizados na barra de filtros (chip de filtros)
134
+ * e no modal lateral de filtros (contêiner de filtros personalizados).
129
135
  */
130
136
  disablePersonalizedFilter: boolean;
131
137
  /**
132
- * Chave da configuração legado da grade.
138
+ * Chave da configuração legada da grade.
133
139
  */
134
140
  gridLegacyConfigName: string;
135
141
  /**
136
- * Chave da configuração legado da barra de filtros.
142
+ * Chave da configuração legada da barra de filtros.
137
143
  */
138
144
  filterBarLegacyConfigName: string;
139
145
  /**
140
- * Define se a carga dos dados será feita assim que o componente for carregado.
146
+ * Define se os dados serão carregados automaticamente na inicialização do componente.
141
147
  */
142
148
  autoLoad?: boolean;
143
149
  /**
144
- * Define se a grid será focada ao ser carregada.
150
+ * Define se a grade receberá o foco automaticamente ao ser carregada.
145
151
  */
146
152
  autoFocus?: boolean;
147
153
  /**
148
- * Ativa inserção de registros no modo grade.
154
+ * Habilita a inserção de registros diretamente na grade.
149
155
  */
150
156
  enableGridInsert?: boolean;
151
157
  /**
152
- * Altera visualmente as sombras e bordas do componente
153
- * Quando false, aplica o padrão de sombras ao componente (Utilizar quando for o elemento principal do layout)
154
- * Quando true, aplica o padrão de outline ao componente (Utilizar quando estiver contido em outro elemento como um painel ou pop-up)
158
+ * Altera a aparência das bordas e sombras do componente.
159
+ * Se `false`, aplica o padrão de sombras (ideal para o elemento principal do layout).
160
+ * Se `true`, aplica um contorno (ideal para quando o componente está dentro de outro, como um painel ou pop-up).
155
161
  */
156
162
  outlineMode?: boolean;
157
163
  /**
158
- * Define se a grade deve suprimir o scroll horizontal.
164
+ * Define se a grade deve suprimir a barra de rolagem horizontal.
159
165
  */
160
166
  suppressHorizontalScroll: boolean;
161
167
  /**
162
- * Modo de exportação dos dados.
168
+ * Define o modo de exportação dos dados.
163
169
  */
164
170
  strategyExporter: IExporterStrategyMode;
165
171
  /**
166
- * Define se a grade deve exibir um buscador de coluna com uso do Ctrl+F
172
+ * Define se a grade deve exibir um buscador de colunas ao pressionar `Ctrl+F`.
167
173
  */
168
174
  useSearchColumn: boolean;
169
175
  /**
170
- * Habilita a edição de múltiplos registros simultâneos.
176
+ * Habilita a edição de múltiplos registros simultaneamente.
171
177
  */
172
178
  multipleEditionEnabled: boolean;
173
179
  /**
174
- * Define se a grid será focada ao ser carregada.
180
+ * Define o modo de exibição do contador de paginação.
175
181
  */
176
182
  paginationCounterMode?: 'show' | 'hidden' | 'auto';
177
183
  /**
178
- * Informa se a coluna de chechbox deve ser suprimida
184
+ * Informa se a coluna de checkbox deve ser suprimida.
179
185
  */
180
186
  suppressCheckboxColumn: boolean;
181
187
  /**
182
- * Define se a grade deve ser exibida em modo compacto
188
+ * Informa se a grade deve suprimir o filtro de coluna.
189
+ */
190
+ suppressFilterColumn?: boolean;
191
+ /**
192
+ * Define se a grade deve ser exibida em modo compacto.
183
193
  */
184
194
  compact: boolean;
185
195
  /**
186
- * Emitido sempre que houver click de botão ou ação.
196
+ * Emitido ao clicar em um botão de ação ou item de menu.
197
+ * @description Este evento é acionado quando o usuário clica em um botão de ação ou item de menu na grade, permitindo a execução de ações específicas.
198
+ * @param {string} detail - O identificador da ação clicada, que pode ser usado para determinar qual ação executar.
187
199
  */
188
200
  actionClick: EventEmitter<string>;
189
201
  /**
190
- * Emitido sempre que houver duplo click na grade.
202
+ * Emitido ao realizar um duplo clique em uma linha da grade.
203
+ * @description Este evento é acionado quando o usuário clica duas vezes em uma linha da grade, permitindo ações como edição rápida ou visualização de detalhes.
204
+ * @param {any} detail - Detalhes do evento, contendo a linha clicada.
191
205
  */
192
206
  gridDoubleClick: EventEmitter<any>;
193
207
  /**
194
208
  * Emitido quando o componente estiver completamente carregado.
195
209
  */
196
210
  componentReady: EventEmitter<void>;
211
+ /**
212
+ * Recarrega a configuração da grade.
213
+ * @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.
214
+ */
197
215
  reloadConfig(): void;
198
216
  /**
199
217
  * Exibe a janela de configurações da grade.
218
+ * @async
219
+ * @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.
220
+ * @returns {Promise<void>} Uma promessa que é resolvida quando a janela de configuração é exibida.
200
221
  */
201
222
  showConfig(): Promise<void>;
202
223
  /**
203
224
  * Fecha a janela de configurações da grade.
225
+ * @async
226
+ * @description Este método fecha o pop-up de configuração de colunas da grade.
227
+ * @returns {Promise<void>} Uma promessa que é resolvida quando a janela de configuração é fechada.
204
228
  */
205
229
  hideConfig(): Promise<void>;
206
230
  /**
207
- * Atribui o valor da configuração da grade.
231
+ * Define a configuração da grade.
232
+ * @async
233
+ * @description Aplica uma nova configuração de colunas e ordenação à grade.
234
+ * @param {IGridConfig} config O objeto de configuração a ser aplicado na grade.
235
+ * @returns {Promise<void>} Uma promessa que é resolvida quando a configuração é aplicada.
208
236
  */
209
237
  setConfig(config: IGridConfig): Promise<void>;
210
238
  /**
211
- * Faz o recarregamento da filter-bar da grade buscando o state no servidor.
239
+ * Recarrega a barra de filtros da grade, buscando o estado do servidor.
240
+ * @async
241
+ * @description Força o recarregamento da barra de filtros, atualizando suas configurações e filtros a partir do servidor.
242
+ * @returns {Promise<void>} Uma promessa que é resolvida quando a barra de filtros é recarregada.
212
243
  */
213
244
  reloadFilterBar(): Promise<void>;
214
245
  /**
215
- * Retorna o elemento da filter-bar da grade.
246
+ * Retorna o elemento da barra de filtros da grade.
247
+ * @async
248
+ * @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.
249
+ * @returns {Promise<HTMLSnkFilterBarElement>} O elemento da barra de filtros.
216
250
  */
217
251
  getFilterBar(): Promise<HTMLSnkFilterBarElement>;
218
252
  /**
219
- * Registra um editor customizado para campos da grade e formulário
253
+ * Registra um editor customizado para um campo da grade ou formulário.
254
+ * @async
255
+ * @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.
256
+ * @param {string} fieldName O nome do campo que receberá o editor customizado.
257
+ * @param {ICustomEditor} customEditor A instância do editor customizado.
258
+ * @param {string} [detailContext] O contexto de detalhe onde o editor será aplicado (opcional).
259
+ * @returns {Promise<void>} Uma promessa que é resolvida quando o editor é registrado.
220
260
  */
221
261
  addCustomEditor(fieldName: string, customEditor: ICustomEditor, detailContext?: string): Promise<void>;
222
262
  /**
223
- * Registra um render customizado para colunas da grid.
263
+ * Registra um renderizador customizado para uma coluna da grade.
264
+ * @async
265
+ * @description Adiciona um componente de renderização personalizado para uma coluna específica, permitindo a exibição de conteúdo customizado nas células.
266
+ * @param {string} fieldName O nome do campo (coluna) que receberá o renderizador customizado.
267
+ * @param {ICustomRender} customRender A instância do renderizador customizado.
268
+ * @param {string} [detailContext] O contexto de detalhe onde o renderizador será aplicado (opcional).
269
+ * @returns {Promise<void>} Uma promessa que é resolvida quando o renderizador é registrado.
224
270
  */
225
271
  addGridCustomRender(fieldName: string, customRender: ICustomRender, detailContext?: string): Promise<void>;
226
272
  /**
227
- * Registra um formatador de valores para uma coluna da grid.
273
+ * Registra um formatador de valor customizado para uma coluna da grade.
274
+ * @async
275
+ * @description Adiciona uma função de formatação personalizada para os valores de uma coluna específica, afetando como os dados são exibidos.
276
+ * @param {string} columnName O nome da coluna que receberá o formatador.
277
+ * @param {ICustomFormatter} customFormatter A instância do formatador de valor.
278
+ * @returns {Promise<void>} Uma promessa que é resolvida quando o formatador é registrado.
228
279
  */
229
280
  addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter): Promise<void>;
230
281
  /**
231
- * Remove o formatador de valores de uma coluna da grid.
282
+ * Remove um formatador de valor customizado de uma coluna da grade.
283
+ * @async
284
+ * @description Remove uma função de formatação personalizada previamente registrada para uma coluna.
285
+ * @param {string} columnName O nome da coluna da qual o formatador será removido.
286
+ * @returns {Promise<void>} Uma promessa que é resolvida quando o formatador é removido.
232
287
  */
233
288
  removeCustomValueFormatter(columnName: string): Promise<void>;
234
289
  /**
235
290
  * Atribui o foco para a grade.
291
+ * @async
292
+ * @description Move o foco do navegador para o componente da grade, permitindo a navegação por teclado.
293
+ * @returns {Promise<void>} Uma promessa que é resolvida quando o foco é atribuído.
236
294
  */
237
295
  setFocus(): Promise<void>;
238
296
  handleClick(event: MouseEvent): Promise<void>;
@@ -26,79 +26,81 @@ export declare class SnkTaskbar {
26
26
  _hasToUpdateOverFlow: boolean;
27
27
  _isWaitingForSave: boolean;
28
28
  /**
29
- * Usado para determinar O alinhamento dos items na taskbar.
29
+ * @description Define o alinhamento dos itens da barra de tarefas à direita.
30
30
  */
31
31
  alignRigth: boolean;
32
32
  /**
33
- * Usado para determinar o identificador do slot que recebe elementos personalizados.
33
+ * @description Define o identificador do slot que recebe elementos personalizados.
34
34
  */
35
35
  customSlotId: string;
36
36
  /**
37
- * Usado para determinar o identificador do container na DOM que é responsavel por guardar os elementos personalizados
37
+ * @description Define o identificador do contêiner na DOM que é responsável por guardar os elementos personalizados
38
38
  * que não podem ser passados por slot.
39
- *
40
- * Exemplo: Elementos customizados na Taskbar da aba de detalhes.
39
+ * @example
40
+ * Elementos customizados na Taskbar da aba de detalhes.
41
41
  */
42
42
  customContainerId: string;
43
43
  /**
44
- * Define como será o comportamento da taskbar quando ocorrer overflow
44
+ * @description Define como será o comportamento da barra de tarefas quando ocorrer um overflow de itens.
45
45
  */
46
46
  overflowStrategy: 'hiddenItems' | 'none';
47
47
  /**
48
- * Usado para guardar ou recuperar as configurações do formulário.
48
+ * @description Nome da configuração usada para salvar ou recuperar as configurações do formulário. Também é utilizado como fallback para a chave de armazenamento do exportador de dados.
49
49
  */
50
50
  configName: string;
51
51
  /**
52
- * Identificador de recursos como configurações e acesso.
52
+ * @description Identificador de recursos, como configurações e permissões de acesso.
53
53
  */
54
54
  resourceID: string;
55
55
  /**
56
- * Lista separada por virgula, contendo todos os elementos a serem criados.
56
+ * @description Lista de botões, separados por vírgula, que define todos os elementos a serem criados na barra de tarefas.
57
57
  */
58
58
  buttons: string;
59
59
  /**
60
- * Mapa com definição de botões personalizados. A chave do mapa deve ser
61
- * passada na lista "buttons" no lugar onde o botão irá aparecer.
60
+ * @description Mapa com definições de botões personalizados. A chave do mapa deve ser informada na propriedade `buttons` no local onde o botão deve ser renderizado.
62
61
  */
63
62
  customButtons: Map<string, CustomButton>;
64
63
  /**
65
- * Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
64
+ * @description Lista de ações a serem exibidas no botão "Mais opções".
66
65
  */
67
66
  actionsList: Array<Action>;
68
67
  /**
69
- * Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
68
+ * @description Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
70
69
  */
71
70
  actionsSettingsList: Array<Action>;
72
71
  /**
73
- * Determina qual botão deve ter aparência primária.
72
+ * @description Define qual botão deve ter a aparência de destaque (primário).
74
73
  */
75
74
  primaryButton: string;
76
75
  /**
77
- * Array contendo todos os botões a serem desabilitados.
76
+ * @description Array contendo os identificadores de todos os botões que devem ser desabilitados.
78
77
  */
79
78
  disabledButtons: Array<string>;
80
79
  /**
81
- * Instância do DataUnit.
80
+ * @description Instância do `DataUnit` com a qual a barra de tarefas irá interagir para realizar operações de dados (ex: salvar, próximo, anterior).
82
81
  */
83
82
  dataUnit: DataUnit;
84
83
  /**
85
- * Altera o modo de apresentação dos botões do snk-taskbar.
84
+ * @description Altera o modo de apresentação dos botões da barra de tarefas.
86
85
  */
87
86
  presentationMode: PresentationMode;
88
87
  /**
89
- * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
88
+ * @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
90
89
  */
91
90
  messagesBuilder: SnkMessageBuilder;
92
91
  /**
93
- * Emitido sempre que houver click de botão ou ação.
92
+ * @description Emitido sempre que um botão ou uma ação da barra de tarefas é clicado.
93
+ * @eventProperty
94
94
  */
95
95
  actionClick: EventEmitter<string>;
96
96
  /**
97
- * Emitido sempre que um save é iniciado pela taskbar.
97
+ * @description Emitido quando uma ação de salvar é iniciada pela barra de tarefas, indicando um estado de bloqueio para evitar ações concorrentes.
98
+ * @eventProperty
98
99
  */
99
100
  taskbarSaveLocker: EventEmitter<void>;
100
101
  /**
101
- * Emitido sempre que o ocorre alguma action que libera o save.
102
+ * @description Emitido quando a ação de salvar é concluída ou cancelada, liberando o estado de bloqueio.
103
+ * @eventProperty
102
104
  */
103
105
  taskbarSaveUnlocker: EventEmitter<void>;
104
106
  handleCustomSlotElementsLoaded(event: CustomEvent): void;