@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.
@@ -47,8 +47,10 @@ const SnkPersonalizedFilter = class {
47
47
  this.resourceID = undefined;
48
48
  this.isDefaultFilter = false;
49
49
  }
50
- /*
51
- * Cria um novo filtro se não houver nenhum filtro existente
50
+ /**
51
+ * Cria um novo filtro personalizado caso não exista nenhum.
52
+ * @method
53
+ * @returns {Promise<void>}
52
54
  */
53
55
  async createPersonalizedFilter() {
54
56
  const newPersonalizedFilter = {
@@ -84,6 +86,12 @@ const SnkPersonalizedFilter = class {
84
86
  this._originalFilterAssistent = core.ObjectUtils.copy(newPersonalizedFilter);
85
87
  this._filterAssistent = core.ObjectUtils.copy(newPersonalizedFilter);
86
88
  }
89
+ /**
90
+ * Carrega o filtro personalizado com base no identificador informado.
91
+ * @watch filterId
92
+ * @param newValue Novo valor do filtroId.
93
+ * @param oldValue Valor anterior do filtroId.
94
+ */
87
95
  loadFilter(newValue, oldValue) {
88
96
  if (newValue == null || oldValue == newValue || this.resourceID == undefined) {
89
97
  return;
@@ -17,11 +17,11 @@ const SnkSimpleBar = class {
17
17
  this.messagesBuilder = undefined;
18
18
  }
19
19
  /**
20
- * Conforme mecanismo de mensagens, é possível customizar as mensagens dos blocos de construção
21
- * através de um pequeno modulo na estrutura da aplicação:
22
- * - Criar um arquivo no seguinte caminho: /messages/appmessages.msg.js.
23
- * Para conhecer os detalhes do módulo, vide o arquivo neste projeto "/src/lib/message/resources/snk-simple-bar.msg.ts"
24
- */
20
+ * Permite customizar as mensagens dos blocos de construção
21
+ * através de um pequeno módulo na estrutura da aplicação:
22
+ * - Crie um arquivo no seguinte caminho: /messages/appmessages.msg.js.
23
+ * Para conhecer os detalhes do módulo, veja o arquivo neste projeto: "/src/lib/message/resources/snk-simple-bar.msg.ts"
24
+ */
25
25
  getMessage(key, params) {
26
26
  var _a;
27
27
  if (this.messagesBuilder)
@@ -86,7 +86,10 @@ const SnkSimpleCrud = class {
86
86
  this.outlineMode = false;
87
87
  }
88
88
  /**
89
- * Registra um editor customizado para campos da grade e formulário.
89
+ * @description Registra um editor customizado para campos da grade e do formulário.
90
+ * @param {string} fieldName - O nome do campo.
91
+ * @param {ICustomEditor} customEditor - A instância do editor customizado.
92
+ * @returns {Promise<void>}
90
93
  */
91
94
  async addCustomEditor(fieldName, customEditor) {
92
95
  if (this._grid && this._form) {
@@ -99,7 +102,10 @@ const SnkSimpleCrud = class {
99
102
  this._customEditors = newCustomEditors;
100
103
  }
101
104
  /**
102
- * Registra um render customizado para colunas da grid.
105
+ * @description Registra um renderizador customizado para colunas da grade.
106
+ * @param {string} fieldName - O nome do campo.
107
+ * @param {ICustomRender} customRender - A instância do renderizador customizado.
108
+ * @returns {Promise<void>}
103
109
  */
104
110
  async addGridCustomRender(fieldName, customRender) {
105
111
  if (this._grid) {
@@ -121,19 +127,28 @@ const SnkSimpleCrud = class {
121
127
  await this.loadGridConfig(true);
122
128
  }
123
129
  /**
124
- * Registra um formatador de valores para uma coluna da grid.
130
+ * @description Registra um formatador de valores para uma coluna da grade.
131
+ * @param {string} columnName - O nome da coluna.
132
+ * @param {ICustomFormatter} customFormatter - A instância do formatador customizado.
133
+ * @returns {Promise<void>}
125
134
  */
126
135
  async addCustomValueFormatter(columnName, customFormatter) {
127
136
  this._grid.addCustomValueFormatter(columnName, customFormatter);
128
137
  }
129
138
  /**
130
- * Remove o formatador de valores de uma coluna da grid.
139
+ * @description Remove o formatador de valores de uma coluna da grade.
140
+ * @param {string} columnName - O nome da coluna.
141
+ * @returns {Promise<void>}
131
142
  */
132
143
  async removeCustomValueFormatter(columnName) {
133
144
  this._grid.removeCustomValueFormatter(columnName);
134
145
  }
135
146
  /**
136
- * Altera/adiciona uma propriedade nos metadados do campo.
147
+ * @description Altera/adiciona uma propriedade nos metadados do campo.
148
+ * @param {string} fieldName - O nome do campo.
149
+ * @param {string} propName - O nome da propriedade.
150
+ * @param {any} value - O valor da propriedade.
151
+ * @returns {Promise<void>}
137
152
  */
138
153
  async setFieldProp(fieldName, propName, value) {
139
154
  const newCustomFieldProps = new Map(this._fieldsProps);
@@ -190,7 +205,9 @@ const SnkSimpleCrud = class {
190
205
  return newTaskBarConfig;
191
206
  }
192
207
  /**
193
- * Usado para alternar a visão entre GRID e FORM externamente.
208
+ * @description Usado para alternar a visão entre GRID e FORM externamente.
209
+ * @param {VIEW_MODE} view - A visão para a qual navegar.
210
+ * @returns {Promise<void>}
194
211
  */
195
212
  async goToView(view) {
196
213
  this._currentViewMode = view;
@@ -464,6 +481,11 @@ const SnkSimpleCrud = class {
464
481
  this.dataUnit = this._inMemoryLoader.dataUnit;
465
482
  this.dataUnitReady.emit(this.dataUnit);
466
483
  }
484
+ /**
485
+ * @description Define os metadados do DataUnit.
486
+ * @param {UnitMetadata} metadata - Os metadados a serem definidos.
487
+ * @returns {Promise<void>}
488
+ */
467
489
  setMetadata(metadata) {
468
490
  if (this._inMemoryLoader) {
469
491
  this._inMemoryLoader.metadata = metadata;
@@ -473,6 +495,11 @@ const SnkSimpleCrud = class {
473
495
  }
474
496
  return Promise.resolve();
475
497
  }
498
+ /**
499
+ * @description Define os registros do DataUnit.
500
+ * @param {Array<Record>} records - Os registros a serem definidos.
501
+ * @returns {Promise<void>}
502
+ */
476
503
  setRecords(records) {
477
504
  if (this._inMemoryLoader) {
478
505
  this._inMemoryLoader.records = records;
@@ -482,23 +509,33 @@ const SnkSimpleCrud = class {
482
509
  }
483
510
  return Promise.resolve();
484
511
  }
512
+ /**
513
+ * @description Obtém os registros do DataUnit.
514
+ * @returns {Promise<Array<Record>>} Uma promessa que resolve com a lista de registros.
515
+ */
485
516
  getRecords() {
486
517
  return Promise.resolve(this.dataUnit.records);
487
518
  }
488
519
  /**
489
- * Usado para abrir o configurator do CRUD
520
+ * @description Usado para abrir o configurador do CRUD.
521
+ * @returns {Promise<void>}
490
522
  */
491
523
  async openConfigurator() {
492
524
  var _a;
493
525
  (_a = this._snkConfigurator) === null || _a === void 0 ? void 0 : _a.open();
494
526
  }
495
527
  /**
496
- * Usado para fechar o configurator do CRUD
528
+ * @description Usado para fechar o configurador do CRUD.
529
+ * @returns {Promise<void>}
497
530
  */
498
531
  async closeConfigurator() {
499
532
  var _a;
500
533
  (_a = this._snkConfigurator) === null || _a === void 0 ? void 0 : _a.close();
501
534
  }
535
+ /**
536
+ * @description Atualiza a configuração do formulário.
537
+ * @returns {Promise<void>}
538
+ */
502
539
  async updateConfig() {
503
540
  if (this._formConfigManager == undefined) {
504
541
  this._formConfigManager = new SnkFormConfigManager.SnkFormConfigManager(this.configName, this.resolveResourceID());
@@ -1,3 +1,21 @@
1
+ /**
2
+ * Componente responsável pela criação, edição e gerenciamento de filtros personalizados.
3
+ *
4
+ * Permite alternar entre os modos assistente e avançado, salvar, cancelar e manipular filtros.
5
+ *
6
+ * @component
7
+ * @example
8
+ * <snk-personalized-filter
9
+ * entityUri="sua/entidade"
10
+ * filterId="idFiltro"
11
+ * configName="nomeConfig"
12
+ * resourceID="resourceId"
13
+ * isDefaultFilter={false}
14
+ * messagesBuilder={messagesBuilderInstance}
15
+ * onEzSave={handler}
16
+ * onEzCancel={handler}
17
+ * />
18
+ */
1
19
  import { h, Host, Fragment } from '@stencil/core';
2
20
  import { ApplicationContext, StringUtils } from '@sankhyalabs/core';
3
21
  import { PersonalizedFilterUtils } from './subcomponents/snk-filter-param-config/utils/PersonalizedFilterUtils';
@@ -34,8 +52,10 @@ export class SnkPersonalizedFilter {
34
52
  this.resourceID = undefined;
35
53
  this.isDefaultFilter = false;
36
54
  }
37
- /*
38
- * Cria um novo filtro se não houver nenhum filtro existente
55
+ /**
56
+ * Cria um novo filtro personalizado caso não exista nenhum.
57
+ * @method
58
+ * @returns {Promise<void>}
39
59
  */
40
60
  async createPersonalizedFilter() {
41
61
  const newPersonalizedFilter = {
@@ -71,6 +91,12 @@ export class SnkPersonalizedFilter {
71
91
  this._originalFilterAssistent = ObjectUtils.copy(newPersonalizedFilter);
72
92
  this._filterAssistent = ObjectUtils.copy(newPersonalizedFilter);
73
93
  }
94
+ /**
95
+ * Carrega o filtro personalizado com base no identificador informado.
96
+ * @watch filterId
97
+ * @param newValue Novo valor do filtroId.
98
+ * @param oldValue Valor anterior do filtroId.
99
+ */
74
100
  loadFilter(newValue, oldValue) {
75
101
  if (newValue == null || oldValue == newValue || this.resourceID == undefined) {
76
102
  return;
@@ -357,7 +383,10 @@ export class SnkPersonalizedFilter {
357
383
  "required": false,
358
384
  "optional": false,
359
385
  "docs": {
360
- "tags": [],
386
+ "tags": [{
387
+ "name": "property",
388
+ "text": undefined
389
+ }],
361
390
  "text": "Respons\u00E1vel por flexibilizar e padronizar o uso de mensagens nos blocos de constru\u00E7\u00E3o."
362
391
  }
363
392
  },
@@ -372,8 +401,11 @@ export class SnkPersonalizedFilter {
372
401
  "required": false,
373
402
  "optional": false,
374
403
  "docs": {
375
- "tags": [],
376
- "text": "Respons\u00E1vel por receber a URI da entidade."
404
+ "tags": [{
405
+ "name": "property",
406
+ "text": undefined
407
+ }],
408
+ "text": "URI da entidade utilizada para buscar os campos dispon\u00EDveis para filtro."
377
409
  },
378
410
  "attribute": "entity-uri",
379
411
  "reflect": false
@@ -389,8 +421,11 @@ export class SnkPersonalizedFilter {
389
421
  "required": false,
390
422
  "optional": false,
391
423
  "docs": {
392
- "tags": [],
393
- "text": "Id do filtro que ser\u00E1 carregado."
424
+ "tags": [{
425
+ "name": "property",
426
+ "text": undefined
427
+ }],
428
+ "text": "Identificador do filtro a ser carregado."
394
429
  },
395
430
  "attribute": "filter-id",
396
431
  "reflect": false
@@ -406,8 +441,11 @@ export class SnkPersonalizedFilter {
406
441
  "required": false,
407
442
  "optional": false,
408
443
  "docs": {
409
- "tags": [],
410
- "text": "Nome da configura\u00E7\u00E3o. Serve para distinguir v\u00E1rias inst\u00E2ncias do componente."
444
+ "tags": [{
445
+ "name": "property",
446
+ "text": undefined
447
+ }],
448
+ "text": "Nome da configura\u00E7\u00E3o, utilizado para distinguir m\u00FAltiplas inst\u00E2ncias do componente."
411
449
  },
412
450
  "attribute": "config-name",
413
451
  "reflect": false
@@ -423,8 +461,11 @@ export class SnkPersonalizedFilter {
423
461
  "required": false,
424
462
  "optional": false,
425
463
  "docs": {
426
- "tags": [],
427
- "text": "Nome da configura\u00E7\u00E3o. Serve para distinguir v\u00E1rias inst\u00E2ncias do componente."
464
+ "tags": [{
465
+ "name": "property",
466
+ "text": undefined
467
+ }],
468
+ "text": "Identificador do recurso utilizado para salvar e recuperar filtros."
428
469
  },
429
470
  "attribute": "resource-i-d",
430
471
  "reflect": false
@@ -440,8 +481,14 @@ export class SnkPersonalizedFilter {
440
481
  "required": false,
441
482
  "optional": false,
442
483
  "docs": {
443
- "tags": [],
444
- "text": "Define se o filtro em quest\u00E3o \u00E9 um filtro padr\u00E3o."
484
+ "tags": [{
485
+ "name": "property",
486
+ "text": undefined
487
+ }, {
488
+ "name": "default",
489
+ "text": "false"
490
+ }],
491
+ "text": "Indica se o filtro \u00E9 o filtro padr\u00E3o do sistema."
445
492
  },
446
493
  "attribute": "is-default-filter",
447
494
  "reflect": false,
@@ -463,8 +510,11 @@ export class SnkPersonalizedFilter {
463
510
  "cancelable": true,
464
511
  "composed": true,
465
512
  "docs": {
466
- "tags": [],
467
- "text": ""
513
+ "tags": [{
514
+ "name": "event",
515
+ "text": undefined
516
+ }],
517
+ "text": "Evento emitido ao cancelar a personaliza\u00E7\u00E3o do filtro."
468
518
  },
469
519
  "complexType": {
470
520
  "original": "void",
@@ -478,8 +528,11 @@ export class SnkPersonalizedFilter {
478
528
  "cancelable": true,
479
529
  "composed": true,
480
530
  "docs": {
481
- "tags": [],
482
- "text": ""
531
+ "tags": [{
532
+ "name": "event",
533
+ "text": undefined
534
+ }],
535
+ "text": "Evento emitido ao salvar as altera\u00E7\u00F5es do filtro personalizado."
483
536
  },
484
537
  "complexType": {
485
538
  "original": "string",
@@ -493,8 +546,11 @@ export class SnkPersonalizedFilter {
493
546
  "cancelable": true,
494
547
  "composed": true,
495
548
  "docs": {
496
- "tags": [],
497
- "text": ""
549
+ "tags": [{
550
+ "name": "event",
551
+ "text": undefined
552
+ }],
553
+ "text": "Evento emitido ap\u00F3s salvar as altera\u00E7\u00F5es do filtro personalizado."
498
554
  },
499
555
  "complexType": {
500
556
  "original": "void",
@@ -521,8 +577,14 @@ export class SnkPersonalizedFilter {
521
577
  "return": "Promise<void>"
522
578
  },
523
579
  "docs": {
524
- "text": "",
525
- "tags": []
580
+ "text": "Cria um novo filtro personalizado caso n\u00E3o exista nenhum.",
581
+ "tags": [{
582
+ "name": "method",
583
+ "text": undefined
584
+ }, {
585
+ "name": "returns",
586
+ "text": undefined
587
+ }]
526
588
  }
527
589
  }
528
590
  };
@@ -7,11 +7,11 @@ export class SnkSimpleBar {
7
7
  this.messagesBuilder = undefined;
8
8
  }
9
9
  /**
10
- * Conforme mecanismo de mensagens, é possível customizar as mensagens dos blocos de construção
11
- * através de um pequeno modulo na estrutura da aplicação:
12
- * - Criar um arquivo no seguinte caminho: /messages/appmessages.msg.js.
13
- * Para conhecer os detalhes do módulo, vide o arquivo neste projeto "/src/lib/message/resources/snk-simple-bar.msg.ts"
14
- */
10
+ * Permite customizar as mensagens dos blocos de construção
11
+ * através de um pequeno módulo na estrutura da aplicação:
12
+ * - Crie um arquivo no seguinte caminho: /messages/appmessages.msg.js.
13
+ * Para conhecer os detalhes do módulo, veja o arquivo neste projeto: "/src/lib/message/resources/snk-simple-bar.msg.ts"
14
+ */
15
15
  getMessage(key, params) {
16
16
  var _a;
17
17
  if (this.messagesBuilder)
@@ -54,7 +54,7 @@ export class SnkSimpleBar {
54
54
  "optional": false,
55
55
  "docs": {
56
56
  "tags": [],
57
- "text": "Define o t\u00EDtulo do header"
57
+ "text": "Define o t\u00EDtulo do header."
58
58
  },
59
59
  "attribute": "label",
60
60
  "reflect": false
@@ -79,7 +79,7 @@ export class SnkSimpleBar {
79
79
  "optional": false,
80
80
  "docs": {
81
81
  "tags": [],
82
- "text": "Define os itens que ser\u00E3o apresentados pelo breadcrumb"
82
+ "text": "Define os itens que ser\u00E3o apresentados no breadcrumb."
83
83
  }
84
84
  },
85
85
  "messagesBuilder": {
@@ -113,7 +113,7 @@ export class SnkSimpleBar {
113
113
  "composed": true,
114
114
  "docs": {
115
115
  "tags": [],
116
- "text": "Emitido quando algum item do breadcrumb \u00E9 clicado"
116
+ "text": "Emitido quando algum item do breadcrumb \u00E9 clicado."
117
117
  },
118
118
  "complexType": {
119
119
  "original": "IBreadcrumbItem",
@@ -133,7 +133,7 @@ export class SnkSimpleBar {
133
133
  "composed": true,
134
134
  "docs": {
135
135
  "tags": [],
136
- "text": "Emitido quando o bot\u00E3o voltar \u00E9 acionado"
136
+ "text": "Emitido quando o bot\u00E3o \"voltar\" \u00E9 acionado."
137
137
  },
138
138
  "complexType": {
139
139
  "original": "void",