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

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.
@@ -46,152 +46,187 @@ export declare class SnkSimpleCrud {
46
46
  _fieldToGetFocus: string;
47
47
  _customContainerId: string;
48
48
  /**
49
- * Define se o componente deve usar o LockManager para controle de carregamento da aplicação
49
+ * @description Define se o componente deve usar o LockManager para controle de carregamento da aplicação.
50
50
  */
51
51
  enableLockManagerLoadingComp?: boolean;
52
52
  /**
53
- * Ativa o gerenciamento de locks na grade pela Taskbar.
53
+ * @description Ativa o gerenciamento de locks na grade pela Taskbar.
54
54
  */
55
55
  enableLockManagerTaskbarClick?: boolean;
56
+ /**
57
+ * @description Estado atual dos dados.
58
+ */
56
59
  dataState: DataState;
60
+ /**
61
+ * @description Instância do DataUnit a ser utilizada pelo componente.
62
+ */
57
63
  dataUnit: DataUnit;
58
64
  /**
59
- * Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD
65
+ * @description Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD.
60
66
  */
61
67
  entityName: string;
68
+ /**
69
+ * @description Define o modo de operação do CRUD (servidor ou em memória).
70
+ */
62
71
  mode: SIMPLE_CRUD_MODE;
72
+ /**
73
+ * @description Configuração da grade.
74
+ */
63
75
  gridConfig: IGridConfig;
76
+ /**
77
+ * @description Configuração do formulário.
78
+ */
64
79
  formConfig: IFormConfig;
65
80
  _formFields: IFieldConfig[];
66
81
  private _fieldsProps;
82
+ /**
83
+ * @description Habilita a inserção contínua de registros.
84
+ */
67
85
  enableContinuousInsert: boolean;
68
86
  /**
69
- * Determina se pode haver mais de uma linha selecionada na grade.
87
+ * @description Determina se pode haver mais de uma linha selecionada na grade.
70
88
  */
71
89
  multipleSelection: boolean;
90
+ /**
91
+ * @description Determina se será usada mensagem de confirmação padrão na tentativa de cancelar a edição.
92
+ */
72
93
  useCancelConfirm: boolean;
73
94
  /**
74
- * Determina quantas linhas são retornadas por página.
95
+ * @description Determina quantas linhas são retornadas por página.
75
96
  */
76
97
  pageSize: number;
77
98
  /**
78
- * Identificador de recursos como configurações e acesso.
99
+ * @description Identificador de recursos como configurações e acesso.
79
100
  */
80
101
  resourceID: string;
81
102
  /**
82
- * Ativa inserção de registros no modo grade.
103
+ * @description Ativa a inserção de registros no modo grade.
83
104
  */
84
105
  enableGridInsert?: boolean;
85
106
  /**
86
- * Define se a grid será focada ao ser carregada.
107
+ * @description Define o modo de exibição do contador de paginação.
87
108
  */
88
109
  paginationCounterMode?: 'show' | 'hidden' | 'auto';
89
110
  /**
90
- * Emitido quando há qualquer mudança de estado no DataUnit.
111
+ * @description Emitido quando há qualquer mudança de estado no DataUnit.
91
112
  */
92
113
  dataStateChange: EventEmitter<DataState>;
93
114
  /**
94
- * Emitido quando o DataUnit está pronto.
115
+ * @description Emitido quando o DataUnit está pronto.
95
116
  */
96
117
  dataUnitReady: EventEmitter<DataUnit>;
97
118
  /**
98
- * Emitido sempre que houver click de botão ou ação.
119
+ * @description Emitido sempre que houver clique de botão ou ação na barra de tarefas.
99
120
  */
100
121
  actionClick: EventEmitter<string>;
101
122
  /**
102
- * Responsável por notificar quando ocorrer a renderização de itens do formulário.
123
+ * @description Responsável por notificar quando ocorrer a renderização de itens do formulário.
103
124
  */
104
125
  formItemsReady: EventEmitter<Array<HTMLElement>>;
105
126
  /**
106
- * Emitido quando salva a configuração no configurator do CRUD.
127
+ * @description Emitido quando a configuração no configurador do CRUD é salva.
107
128
  */
108
129
  configuratorSave: EventEmitter<any>;
109
130
  /**
110
- * Emitido quando cancela o salvamento da configuração no configurator do CRUD.
131
+ * @description Emitido quando o salvamento da configuração no configurador do CRUD é cancelado.
111
132
  */
112
133
  configuratorCancel: EventEmitter<any>;
113
134
  /**
114
- * Gerenciador das barras de tarefas. É possível determinar botões específicos
115
- * ou mesmo gerenciar o estado dos botões.
116
- */
135
+ * @description Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões.
136
+ */
117
137
  taskbarManager: TaskbarManager;
118
138
  /**
119
- * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
139
+ * @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
120
140
  */
121
141
  messagesBuilder: SnkMessageBuilder;
122
142
  /**
123
- * Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade.
143
+ * @description Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade.
124
144
  */
125
145
  useEnterLikeTab: boolean;
126
146
  /**
127
- * Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar.
147
+ * @description Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar.
128
148
  */
129
149
  actionsList: Array<Action>;
130
150
  /**
131
- * Usado para salvar as configurações dos blocos de construção.
151
+ * @description Usado para salvar as configurações dos blocos de construção.
132
152
  */
133
153
  configName: string;
134
154
  /**
135
- * Usado para exibir os botões de ação do snk-configurator.
155
+ * @description Usado para exibir os botões de ação do snk-configurator.
136
156
  */
137
157
  showConfiguratorButtons: boolean;
138
158
  /**
139
- * Chave da configuração legado da grade.
159
+ * @description Chave da configuração legada da grade.
140
160
  */
141
161
  gridLegacyConfigName: string;
142
162
  /**
143
- * Chave da configuração legado do formulário.
163
+ * @description Chave da configuração legada do formulário.
144
164
  */
145
165
  formLegacyConfigName: string;
146
166
  /**
147
- * Ignora os campos "somente leitura" no modo de inserção.
167
+ * @description Ignora os campos "somente leitura" no modo de inserção.
148
168
  */
149
169
  ignoreReadOnlyFormFields: boolean;
150
170
  /**
151
- * Define se a grid será focada ao ser carregada.
171
+ * @description Define se a grade será focada ao ser carregada.
152
172
  */
153
173
  autoFocus?: boolean;
154
174
  /**
155
- * Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade)
156
- */
175
+ * @description Define a chave customizada para sobrescrever as mensagens (não pegando pela entidade).
176
+ */
157
177
  domainMessagesBuilder: string;
158
178
  /**
159
- * Habilita a edição de múltiplos registros simultâneos.
179
+ * @description Habilita a edição de múltiplos registros simultâneos.
160
180
  */
161
181
  multipleEditionEnabled: boolean;
162
182
  /**
163
- * Define se o LayoutFormConfig será exibido no configurador.
183
+ * @description Define se o LayoutFormConfig será exibido no configurador.
164
184
  */
165
185
  layoutFormConfig: boolean;
166
186
  /**
167
- * Registra um editor customizado para campos da grade e formulário.
187
+ * @description Registra um editor customizado para campos da grade e do formulário.
188
+ * @param {string} fieldName - O nome do campo.
189
+ * @param {ICustomEditor} customEditor - A instância do editor customizado.
190
+ * @returns {Promise<void>}
168
191
  */
169
192
  addCustomEditor(fieldName: string, customEditor: ICustomEditor): Promise<void>;
170
193
  /**
171
- * Registra um render customizado para colunas da grid.
194
+ * @description Registra um renderizador customizado para colunas da grade.
195
+ * @param {string} fieldName - O nome do campo.
196
+ * @param {ICustomRender} customRender - A instância do renderizador customizado.
197
+ * @returns {Promise<void>}
172
198
  */
173
199
  addGridCustomRender(fieldName: string, customRender: ICustomRender): Promise<void>;
174
200
  /**
175
- * Define se a carga dos dados será feita assim que o componente for carregado.
201
+ * @description Define se a carga dos dados será feita assim que o componente for carregado.
176
202
  */
177
203
  autoLoad?: boolean;
178
204
  /**
179
- * Altera visualmente as sombras e bordas do componente
180
- * Quando false, aplica o padrão de sombras ao componente (Utilizar quando for o elemento principal do layout)
181
- * Quando true, aplica o padrão de outline ao componente (Utilizar quando estiver contido em outro elemento como um painel ou pop-up)
182
- */
205
+ * @description Altera visualmente as sombras e bordas do componente.
206
+ * Quando `false`, aplica o padrão de sombras ao componente (utilizar quando for o elemento principal do layout).
207
+ * Quando `true`, aplica o padrão de contorno ao componente (utilizar quando estiver contido em outro elemento como um painel ou pop-up).
208
+ */
183
209
  outlineMode?: boolean;
184
210
  handleResourceIDChanged(newValue: string, oldValue: string): Promise<void>;
185
211
  /**
186
- * Registra um formatador de valores para uma coluna da grid.
212
+ * @description Registra um formatador de valores para uma coluna da grade.
213
+ * @param {string} columnName - O nome da coluna.
214
+ * @param {ICustomFormatter} customFormatter - A instância do formatador customizado.
215
+ * @returns {Promise<void>}
187
216
  */
188
217
  addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter): Promise<void>;
189
218
  /**
190
- * Remove o formatador de valores de uma coluna da grid.
219
+ * @description Remove o formatador de valores de uma coluna da grade.
220
+ * @param {string} columnName - O nome da coluna.
221
+ * @returns {Promise<void>}
191
222
  */
192
223
  removeCustomValueFormatter(columnName: string): Promise<void>;
193
224
  /**
194
- * Altera/adiciona uma propriedade nos metadados do campo.
225
+ * @description Altera/adiciona uma propriedade nos metadados do campo.
226
+ * @param {string} fieldName - O nome do campo.
227
+ * @param {string} propName - O nome da propriedade.
228
+ * @param {any} value - O valor da propriedade.
229
+ * @returns {Promise<void>}
195
230
  */
196
231
  setFieldProp(fieldName: string, propName: string, value: any): Promise<void>;
197
232
  private loadTaskbarProcessor;
@@ -202,7 +237,9 @@ export declare class SnkSimpleCrud {
202
237
  private get application();
203
238
  resolveInMemoryBtns(taskbarButtons: Array<string>): Array<string>;
204
239
  /**
205
- * Usado para alternar a visão entre GRID e FORM externamente.
240
+ * @description Usado para alternar a visão entre GRID e FORM externamente.
241
+ * @param {VIEW_MODE} view - A visão para a qual navegar.
242
+ * @returns {Promise<void>}
206
243
  */
207
244
  goToView(view: VIEW_MODE): Promise<void>;
208
245
  actionClickListener(evt: CustomEvent): void;
@@ -236,17 +273,37 @@ export declare class SnkSimpleCrud {
236
273
  private setFieldsProps;
237
274
  getTaskBarId(): string;
238
275
  initInMemoryDataUnit(): void;
276
+ /**
277
+ * @description Define os metadados do DataUnit.
278
+ * @param {UnitMetadata} metadata - Os metadados a serem definidos.
279
+ * @returns {Promise<void>}
280
+ */
239
281
  setMetadata(metadata: UnitMetadata): Promise<void>;
282
+ /**
283
+ * @description Define os registros do DataUnit.
284
+ * @param {Array<Record>} records - Os registros a serem definidos.
285
+ * @returns {Promise<void>}
286
+ */
240
287
  setRecords(records: Array<Record>): Promise<void>;
288
+ /**
289
+ * @description Obtém os registros do DataUnit.
290
+ * @returns {Promise<Array<Record>>} Uma promessa que resolve com a lista de registros.
291
+ */
241
292
  getRecords(): Promise<Array<Record>>;
242
293
  /**
243
- * Usado para abrir o configurator do CRUD
294
+ * @description Usado para abrir o configurador do CRUD.
295
+ * @returns {Promise<void>}
244
296
  */
245
297
  openConfigurator(): Promise<void>;
246
298
  /**
247
- * Usado para fechar o configurator do CRUD
299
+ * @description Usado para fechar o configurador do CRUD.
300
+ * @returns {Promise<void>}
248
301
  */
249
302
  closeConfigurator(): Promise<void>;
303
+ /**
304
+ * @description Atualiza a configuração do formulário.
305
+ * @returns {Promise<void>}
306
+ */
250
307
  updateConfig(): Promise<void>;
251
308
  processMetadata(): void;
252
309
  private addGridCustomValueFormattters;