@sankhyalabs/sankhyablocks 2.3.0 → 2.4.1

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 (122) hide show
  1. package/dist/cjs/snk-application.cjs.entry.js +46 -29
  2. package/dist/cjs/snk-config-options.cjs.entry.js +1 -1
  3. package/dist/cjs/snk-configurator_3.cjs.entry.js +13 -7
  4. package/dist/cjs/snk-crud.cjs.entry.js +2 -2
  5. package/dist/cjs/snk-data-unit.cjs.entry.js +2 -4
  6. package/dist/cjs/snk-filter-bar_7.cjs.entry.js +27 -6
  7. package/dist/cjs/snk-filter-binary-select.cjs.entry.js +6 -0
  8. package/dist/cjs/snk-filter-detail.cjs.entry.js +4 -1
  9. package/dist/cjs/snk-filter-multi-select.cjs.entry.js +6 -0
  10. package/dist/cjs/snk-filter-number.cjs.entry.js +6 -0
  11. package/dist/cjs/snk-filter-period.cjs.entry.js +6 -0
  12. package/dist/cjs/snk-filter-personalized.cjs.entry.js +3 -0
  13. package/dist/cjs/snk-filter-search.cjs.entry.js +6 -0
  14. package/dist/cjs/snk-filter-text.cjs.entry.js +3 -0
  15. package/dist/cjs/snk-form-config.cjs.entry.js +2 -2
  16. package/dist/cjs/snk-form.cjs.entry.js +4 -4
  17. package/dist/collection/components/snk-application/snk-application.js +82 -65
  18. package/dist/collection/components/snk-configurator/snk-configurator.js +11 -5
  19. package/dist/collection/components/snk-crud/snk-crud.js +6 -6
  20. package/dist/collection/components/snk-data-unit/snk-data-unit.js +14 -19
  21. package/dist/collection/components/snk-filter-bar/filter-item/editors/snk-filter-binary-select.js +9 -3
  22. package/dist/collection/components/snk-filter-bar/filter-item/editors/snk-filter-multi-select.js +9 -3
  23. package/dist/collection/components/snk-filter-bar/filter-item/editors/snk-filter-number.js +9 -3
  24. package/dist/collection/components/snk-filter-bar/filter-item/editors/snk-filter-period.js +9 -3
  25. package/dist/collection/components/snk-filter-bar/filter-item/editors/snk-filter-personalized.js +6 -3
  26. package/dist/collection/components/snk-filter-bar/filter-item/editors/snk-filter-search.js +9 -3
  27. package/dist/collection/components/snk-filter-bar/filter-item/editors/snk-filter-text.js +5 -2
  28. package/dist/collection/components/snk-filter-bar/filter-item/snk-filter-detail.js +8 -5
  29. package/dist/collection/components/snk-filter-bar/filter-item/snk-filter-item.js +16 -7
  30. package/dist/collection/components/snk-filter-bar/filter-list/snk-filter-list.js +12 -9
  31. package/dist/collection/components/snk-filter-bar/filter-modal/snk-filter-modal.js +9 -9
  32. package/dist/collection/components/snk-filter-bar/snk-filter-bar.js +5 -2
  33. package/dist/collection/components/snk-form/snk-form.js +11 -11
  34. package/dist/collection/components/snk-form/subcomponents/snk-config-options/snk-config-options.js +5 -5
  35. package/dist/collection/components/snk-form/subcomponents/snk-field-config/snk-field-config.js +6 -6
  36. package/dist/collection/components/snk-form/subcomponents/snk-form-config/snk-form-config.js +6 -6
  37. package/dist/collection/components/snk-form/subcomponents/snk-tab-config/snk-tab-config.js +7 -7
  38. package/dist/collection/components/snk-grid/snk-grid.js +14 -14
  39. package/dist/collection/components/snk-grid/subcomponents/snk-grid-config/snk-grid-config.js +8 -5
  40. package/dist/collection/components/snk-grid/subcomponents/snk-select-box/snk-select-box.js +5 -2
  41. package/dist/collection/components/snk-pesquisa/snk-pesquisa.js +11 -10
  42. package/dist/collection/components/snk-taskbar/snk-taskbar.js +10 -10
  43. package/dist/components/snk-application2.js +47 -30
  44. package/dist/components/snk-config-options2.js +1 -1
  45. package/dist/components/snk-configurator2.js +6 -0
  46. package/dist/components/snk-crud.js +3 -3
  47. package/dist/components/snk-data-unit.js +2 -4
  48. package/dist/components/snk-field-config2.js +2 -2
  49. package/dist/components/snk-filter-bar2.js +4 -1
  50. package/dist/components/snk-filter-binary-select.js +6 -0
  51. package/dist/components/snk-filter-detail2.js +4 -1
  52. package/dist/components/snk-filter-item2.js +10 -1
  53. package/dist/components/snk-filter-list2.js +3 -0
  54. package/dist/components/snk-filter-multi-select.js +6 -0
  55. package/dist/components/snk-filter-number.js +6 -0
  56. package/dist/components/snk-filter-period.js +6 -0
  57. package/dist/components/snk-filter-personalized.js +3 -0
  58. package/dist/components/snk-filter-search.js +6 -0
  59. package/dist/components/snk-filter-text.js +3 -0
  60. package/dist/components/snk-form-config2.js +3 -3
  61. package/dist/components/snk-form2.js +4 -4
  62. package/dist/components/snk-grid-config2.js +6 -3
  63. package/dist/components/snk-grid2.js +5 -5
  64. package/dist/components/snk-select-box2.js +3 -0
  65. package/dist/components/snk-taskbar2.js +3 -3
  66. package/dist/esm/snk-application.entry.js +47 -30
  67. package/dist/esm/snk-config-options.entry.js +1 -1
  68. package/dist/esm/snk-configurator_3.entry.js +13 -7
  69. package/dist/esm/snk-crud.entry.js +3 -3
  70. package/dist/esm/snk-data-unit.entry.js +2 -4
  71. package/dist/esm/snk-filter-bar_7.entry.js +27 -6
  72. package/dist/esm/snk-filter-binary-select.entry.js +6 -0
  73. package/dist/esm/snk-filter-detail.entry.js +4 -1
  74. package/dist/esm/snk-filter-multi-select.entry.js +6 -0
  75. package/dist/esm/snk-filter-number.entry.js +6 -0
  76. package/dist/esm/snk-filter-period.entry.js +6 -0
  77. package/dist/esm/snk-filter-personalized.entry.js +3 -0
  78. package/dist/esm/snk-filter-search.entry.js +6 -0
  79. package/dist/esm/snk-filter-text.entry.js +3 -0
  80. package/dist/esm/snk-form-config.entry.js +3 -3
  81. package/dist/esm/snk-form.entry.js +4 -4
  82. package/dist/sankhyablocks/p-2e0747f9.entry.js +1 -0
  83. package/dist/sankhyablocks/{p-de0fe8a4.entry.js → p-60e7e86d.entry.js} +1 -1
  84. package/dist/sankhyablocks/p-825c8975.entry.js +1 -0
  85. package/dist/sankhyablocks/{p-0e18f6e6.entry.js → p-a72a0a5d.entry.js} +2 -2
  86. package/dist/sankhyablocks/p-cd486089.entry.js +1 -0
  87. package/dist/sankhyablocks/p-d2b0f1fc.entry.js +1 -0
  88. package/dist/sankhyablocks/p-d61f2170.entry.js +1 -0
  89. package/dist/sankhyablocks/sankhyablocks.esm.js +1 -1
  90. package/dist/types/components/snk-application/snk-application.d.ts +48 -32
  91. package/dist/types/components/snk-configurator/snk-configurator.d.ts +9 -3
  92. package/dist/types/components/snk-crud/snk-crud.d.ts +4 -4
  93. package/dist/types/components/snk-data-unit/snk-data-unit.d.ts +12 -14
  94. package/dist/types/components/snk-filter-bar/filter-item/editors/snk-filter-binary-select.d.ts +12 -0
  95. package/dist/types/components/snk-filter-bar/filter-item/editors/snk-filter-multi-select.d.ts +12 -0
  96. package/dist/types/components/snk-filter-bar/filter-item/editors/snk-filter-number.d.ts +12 -0
  97. package/dist/types/components/snk-filter-bar/filter-item/editors/snk-filter-period.d.ts +12 -0
  98. package/dist/types/components/snk-filter-bar/filter-item/editors/snk-filter-personalized.d.ts +9 -0
  99. package/dist/types/components/snk-filter-bar/filter-item/editors/snk-filter-search.d.ts +12 -0
  100. package/dist/types/components/snk-filter-bar/filter-item/editors/snk-filter-text.d.ts +9 -0
  101. package/dist/types/components/snk-filter-bar/filter-item/snk-filter-detail.d.ts +12 -0
  102. package/dist/types/components/snk-filter-bar/filter-item/snk-filter-item.d.ts +20 -2
  103. package/dist/types/components/snk-filter-bar/filter-list/snk-filter-list.d.ts +27 -0
  104. package/dist/types/components/snk-filter-bar/filter-modal/snk-filter-modal.d.ts +28 -1
  105. package/dist/types/components/snk-filter-bar/snk-filter-bar.d.ts +4 -1
  106. package/dist/types/components/snk-form/snk-form.d.ts +7 -7
  107. package/dist/types/components/snk-form/subcomponents/snk-config-options/snk-config-options.d.ts +4 -4
  108. package/dist/types/components/snk-form/subcomponents/snk-field-config/snk-field-config.d.ts +5 -5
  109. package/dist/types/components/snk-form/subcomponents/snk-form-config/snk-form-config.d.ts +4 -4
  110. package/dist/types/components/snk-form/subcomponents/snk-tab-config/snk-tab-config.d.ts +8 -10
  111. package/dist/types/components/snk-grid/snk-grid.d.ts +9 -9
  112. package/dist/types/components/snk-grid/subcomponents/snk-grid-config/snk-grid-config.d.ts +5 -2
  113. package/dist/types/components/snk-grid/subcomponents/snk-select-box/snk-select-box.d.ts +6 -0
  114. package/dist/types/components/snk-pesquisa/snk-pesquisa.d.ts +12 -2
  115. package/dist/types/components/snk-taskbar/snk-taskbar.d.ts +8 -8
  116. package/dist/types/components.d.ts +428 -135
  117. package/package.json +2 -2
  118. package/dist/sankhyablocks/p-00f6d216.entry.js +0 -1
  119. package/dist/sankhyablocks/p-6ca95ef3.entry.js +0 -1
  120. package/dist/sankhyablocks/p-7e79ab39.entry.js +0 -1
  121. package/dist/sankhyablocks/p-975182f8.entry.js +0 -1
  122. package/dist/sankhyablocks/p-c4e9394c.entry.js +0 -1
@@ -17,6 +17,9 @@ export class EzGridConfig {
17
17
  this.selectedIndex = 0;
18
18
  }
19
19
  /* Creation Methods */
20
+ /**
21
+ * Salva as configurações da grade.
22
+ */
20
23
  async saveConfig(config) {
21
24
  var _a;
22
25
  if (config == undefined || ((_a = this._application) === null || _a === void 0 ? void 0 : _a.configName) == undefined) {
@@ -100,11 +103,11 @@ export class EzGridConfig {
100
103
  this._columListItems = [visibleGroup, hiddenGroup];
101
104
  }
102
105
  buildColumnListSlot(item, group) {
103
- const dataElementId = `${this._element.getAttribute("data-element-id")}_configItem_${StringUtils.toCamelCase(item.label)}`;
106
+ const dataElementId = `${this._element.getAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME)}_configItem_${StringUtils.toCamelCase(item.label)}`;
104
107
  return (h("div", null, h("ez-check", { mode: 'switch', id: 'switch' + ((item === null || item === void 0 ? void 0 : item.label) || '') + ((group === null || group === void 0 ? void 0 : group.group) || ''), value: group.group === this.getMessage("snkGridConfig.group.visible"), "data-element-id": dataElementId, onEzChange: (evt) => { this.switchColumnGroup(evt, item); } })));
105
108
  }
106
109
  buildOrderListSlot(item) {
107
- const dataElementId = `${this._element.getAttribute("data-element-id")}_configItem_${StringUtils.toCamelCase(item.label)}`;
110
+ const dataElementId = `${this._element.getAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME)}_configItem_${StringUtils.toCamelCase(item.label)}`;
108
111
  let selectedOption = ORDER_VALUES.none.value;
109
112
  if ((item === null || item === void 0 ? void 0 : item.ascending) != undefined) {
110
113
  selectedOption = item.ascending == true ? ORDER_VALUES.asc.value : ORDER_VALUES.desc.value;
@@ -552,7 +555,7 @@ export class EzGridConfig {
552
555
  "composed": true,
553
556
  "docs": {
554
557
  "tags": [],
555
- "text": "Evento disparado ao salvar a altera\u00E7\u00E3o das configura\u00E7\u00F5es."
558
+ "text": "Emitido ao salvar a altera\u00E7\u00E3o das configura\u00E7\u00F5es."
556
559
  },
557
560
  "complexType": {
558
561
  "original": "IGridConfig",
@@ -572,7 +575,7 @@ export class EzGridConfig {
572
575
  "composed": true,
573
576
  "docs": {
574
577
  "tags": [],
575
- "text": "Evento disparado ao cancelar a altera\u00E7\u00E3o das configura\u00E7\u00F5es."
578
+ "text": "Emitido ao cancelar a altera\u00E7\u00E3o das configura\u00E7\u00F5es."
576
579
  },
577
580
  "complexType": {
578
581
  "original": "void",
@@ -602,7 +605,7 @@ export class EzGridConfig {
602
605
  "return": "Promise<void>"
603
606
  },
604
607
  "docs": {
605
- "text": "",
608
+ "text": "Salva as configura\u00E7\u00F5es da grade.",
606
609
  "tags": []
607
610
  }
608
611
  }
@@ -2,6 +2,9 @@ import { h } from '@stencil/core';
2
2
  import { ORDER_VALUES } from '../../../../lib/utils/constants';
3
3
  export class SelectBox {
4
4
  constructor() {
5
+ /**
6
+ * Determina a opção selecionada.
7
+ */
5
8
  this.selectedOption = ORDER_VALUES.none;
6
9
  }
7
10
  render() {
@@ -41,7 +44,7 @@ export class SelectBox {
41
44
  "optional": false,
42
45
  "docs": {
43
46
  "tags": [],
44
- "text": ""
47
+ "text": "Determina a op\u00E7\u00E3o selecionada."
45
48
  },
46
49
  "attribute": "selected-option",
47
50
  "reflect": false,
@@ -58,7 +61,7 @@ export class SelectBox {
58
61
  "composed": true,
59
62
  "docs": {
60
63
  "tags": [],
61
- "text": ""
64
+ "text": "Emitido ao alterar a sele\u00E7\u00E3o do componente snk-select-box."
62
65
  },
63
66
  "complexType": {
64
67
  "original": "string",
@@ -319,10 +319,10 @@ export class SnkPesquisa {
319
319
  "type": "unknown",
320
320
  "mutable": false,
321
321
  "complexType": {
322
- "original": "Function",
323
- "resolved": "Function",
322
+ "original": "(text: string) => Promise<any>",
323
+ "resolved": "(text: string) => Promise<any>",
324
324
  "references": {
325
- "Function": {
325
+ "Promise": {
326
326
  "location": "global"
327
327
  }
328
328
  }
@@ -331,18 +331,19 @@ export class SnkPesquisa {
331
331
  "optional": false,
332
332
  "docs": {
333
333
  "tags": [],
334
- "text": ""
334
+ "text": "Fun\u00E7\u00E3o respons\u00E1vel em carregar os itens do componente snk-pesquisa."
335
335
  }
336
336
  },
337
337
  "selectItem": {
338
338
  "type": "unknown",
339
339
  "mutable": false,
340
340
  "complexType": {
341
- "original": "Function",
342
- "resolved": "Function",
341
+ "original": "(option: IOption) => void",
342
+ "resolved": "(option: IOption) => void",
343
343
  "references": {
344
- "Function": {
345
- "location": "global"
344
+ "IOption": {
345
+ "location": "import",
346
+ "path": "@sankhyalabs/ezui/dist/types/components/ez-combo-box/ez-combo-box"
346
347
  }
347
348
  }
348
349
  },
@@ -350,7 +351,7 @@ export class SnkPesquisa {
350
351
  "optional": false,
351
352
  "docs": {
352
353
  "tags": [],
353
- "text": ""
354
+ "text": "Fun\u00E7\u00E3o disparada ao selecionar um item."
354
355
  }
355
356
  },
356
357
  "argument": {
@@ -365,7 +366,7 @@ export class SnkPesquisa {
365
366
  "optional": false,
366
367
  "docs": {
367
368
  "tags": [],
368
- "text": ""
369
+ "text": "Argumentos que ser\u00E3o usados ao chamar a fun\u00E7\u00E3o searchLoader."
369
370
  },
370
371
  "attribute": "argument",
371
372
  "reflect": false
@@ -115,11 +115,11 @@ export class SnkTaskbar {
115
115
  }
116
116
  }
117
117
  getIdElemBtnNative(taskbarElem) {
118
- const elemIdTaskbar = this._element.getAttribute("data-element-id");
118
+ const elemIdTaskbar = this._element.getAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME);
119
119
  return `${elemIdTaskbar}_${StringUtils.toCamelCase(taskbarElem)}`;
120
120
  }
121
121
  getIdElemBtnCustom(btnCustom) {
122
- const elemIdTaskbar = this._element.getAttribute("data-element-id");
122
+ const elemIdTaskbar = this._element.getAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME);
123
123
  return `${elemIdTaskbar}_${StringUtils.toCamelCase(btnCustom.name)}`;
124
124
  }
125
125
  isDivider(element) {
@@ -207,7 +207,7 @@ export class SnkTaskbar {
207
207
  "optional": false,
208
208
  "docs": {
209
209
  "tags": [],
210
- "text": "Nome usado para guardar/recuperar as configura\u00E7\u00F5es do formul\u00E1rio"
210
+ "text": "Usado para guardar ou recuperar as configura\u00E7\u00F5es do formul\u00E1rio."
211
211
  },
212
212
  "attribute": "config-name",
213
213
  "reflect": false
@@ -224,7 +224,7 @@ export class SnkTaskbar {
224
224
  "optional": false,
225
225
  "docs": {
226
226
  "tags": [],
227
- "text": "Lista separada por virgula, contendo todos os elementos a serem criados"
227
+ "text": "Lista separada por virgula, contendo todos os elementos a serem criados."
228
228
  },
229
229
  "attribute": "buttons",
230
230
  "reflect": false
@@ -270,7 +270,7 @@ export class SnkTaskbar {
270
270
  "optional": false,
271
271
  "docs": {
272
272
  "tags": [],
273
- "text": "Lista de a\u00E7\u00F5es que devem ser usadas no bot\u00E3o \"Mais op\u00E7\u00F5es\""
273
+ "text": "Lista de a\u00E7\u00F5es que devem ser usadas no bot\u00E3o \"Mais op\u00E7\u00F5es\" do componente snk-taskbar."
274
274
  }
275
275
  },
276
276
  "primaryButton": {
@@ -285,7 +285,7 @@ export class SnkTaskbar {
285
285
  "optional": false,
286
286
  "docs": {
287
287
  "tags": [],
288
- "text": "Qual bot\u00E3o deve ter apar\u00EAncia prim\u00E1ria"
288
+ "text": "Determina qual bot\u00E3o deve ter apar\u00EAncia prim\u00E1ria."
289
289
  },
290
290
  "attribute": "primary-button",
291
291
  "reflect": false
@@ -306,7 +306,7 @@ export class SnkTaskbar {
306
306
  "optional": false,
307
307
  "docs": {
308
308
  "tags": [],
309
- "text": "Array contendo todos os bot\u00F5es a serem desabilitados"
309
+ "text": "Array contendo todos os bot\u00F5es a serem desabilitados."
310
310
  }
311
311
  },
312
312
  "dataUnit": {
@@ -326,7 +326,7 @@ export class SnkTaskbar {
326
326
  "optional": false,
327
327
  "docs": {
328
328
  "tags": [],
329
- "text": "Inst\u00E2ncia do DataUnit"
329
+ "text": "Inst\u00E2ncia do DataUnit."
330
330
  }
331
331
  }
332
332
  };
@@ -345,7 +345,7 @@ export class SnkTaskbar {
345
345
  "composed": true,
346
346
  "docs": {
347
347
  "tags": [],
348
- "text": "Emitido sempre que houver click de bot\u00E3o ou a\u00E7\u00E3o"
348
+ "text": "Emitido sempre que houver click de bot\u00E3o ou a\u00E7\u00E3o."
349
349
  },
350
350
  "complexType": {
351
351
  "original": "string",
@@ -360,7 +360,7 @@ export class SnkTaskbar {
360
360
  "composed": true,
361
361
  "docs": {
362
362
  "tags": [],
363
- "text": "Emitido sempre que houver altera\u00E7\u00E3o em algum elemento aberto pelo bot\u00E3o de a\u00E7\u00E3o"
363
+ "text": "Emitido sempre que houver altera\u00E7\u00E3o em algum elemento aberto pelo bot\u00E3o de a\u00E7\u00E3o."
364
364
  },
365
365
  "complexType": {
366
366
  "original": "any",
@@ -1,5 +1,5 @@
1
1
  import { proxyCustomElement, HTMLElement, createEvent, h } from '@stencil/core/internal/client';
2
- import { WaitingChangeException, WarningException, ErrorException, ObjectUtils, DataType, DataUnit, StringUtils, ChangeOperation, DateUtils, DependencyType, ApplicationContext, ErrorTracking, ElementIDUtils } from '@sankhyalabs/core';
2
+ import { WaitingChangeException, WarningException, ErrorException, ObjectUtils, DataType, DataUnit, StringUtils, ChangeOperation, DateUtils, DependencyType, ElementIDUtils, ApplicationContext, ErrorTracking } from '@sankhyalabs/core';
3
3
  import { d as dist, D as DataFetcher, R as ResourceFetcher, U as UrlUtils, F as FormConfigFetcher, G as GridConfigFetcher, C as ConfigStorage } from './ConfigStorage.js';
4
4
  import { ApplicationUtils } from '@sankhyalabs/ezui/dist/collection/utils';
5
5
  import { S as SnkMessageBuilder } from './SnkMessageBuilder.js';
@@ -706,7 +706,7 @@ const SnkApplication = /*@__PURE__*/ proxyCustomElement(class extends HTMLElemen
706
706
  }
707
707
  }
708
708
  /**
709
- * Caso o usuário logado seja o SUP.
709
+ * Obtém `true` caso o usuário logado seja o SUP.
710
710
  */
711
711
  async isUserSup() {
712
712
  return new Promise((resolve, reject) => {
@@ -718,7 +718,7 @@ const SnkApplication = /*@__PURE__*/ proxyCustomElement(class extends HTMLElemen
718
718
  });
719
719
  }
720
720
  /**
721
- * Se o usuário logado tem permissão pra determinada ação.
721
+ * Obtém `true` caso o usuário logado tem permissão pra determinada ação.
722
722
  */
723
723
  async hasAccess(access) {
724
724
  return new Promise((resolve, reject) => {
@@ -730,7 +730,7 @@ const SnkApplication = /*@__PURE__*/ proxyCustomElement(class extends HTMLElemen
730
730
  });
731
731
  }
732
732
  /**
733
- * Retorna todos os acessos do usuário logado.
733
+ * Obtém todos os acessos do usuário logado.
734
734
  */
735
735
  async getAllAccess() {
736
736
  return new Promise((resolve, reject) => {
@@ -747,37 +747,37 @@ const SnkApplication = /*@__PURE__*/ proxyCustomElement(class extends HTMLElemen
747
747
  });
748
748
  }
749
749
  /**
750
- * Retorna o valor de um parâmetro do tipo string.
750
+ * Obtém o valor de um parâmetro do tipo string.
751
751
  */
752
752
  async getStringParam(name) {
753
753
  return this.parameters.asString(name);
754
754
  }
755
755
  /**
756
- * Retorna o valor de um parâmetro do tipo Inteiro.
756
+ * Obtém o valor de um parâmetro do tipo Inteiro.
757
757
  */
758
758
  async getIntParam(name) {
759
759
  return this.parameters.asInteger(name);
760
760
  }
761
761
  /**
762
- * Retorna o valor de um parâmetro do tipo Decimal.
762
+ * Obtém o valor de um parâmetro do tipo Decimal.
763
763
  */
764
764
  async getFloatParam(name) {
765
765
  return this.parameters.asFloat(name);
766
766
  }
767
767
  /**
768
- * Retorna o valor de um parâmetro do tipo booleano.
768
+ * Obtém o valor de um parâmetro do tipo booleano.
769
769
  */
770
770
  async getBooleanParam(name) {
771
771
  return this.parameters.asBoolean(name);
772
772
  }
773
773
  /**
774
- * Retorna o valor de um parâmetro do tipo data.
774
+ * Obtém o valor de um parâmetro do tipo data.
775
775
  */
776
776
  async getDateParam(name) {
777
777
  return this.parameters.asDate(name);
778
778
  }
779
779
  /**
780
- * Mostra o conteúdo passado em um Popup
780
+ * Exibe o conteúdo passado em um Popup.
781
781
  */
782
782
  async showPopUp(content, size = "full", useHeader = true) {
783
783
  this.clearContent(this._popUp);
@@ -789,17 +789,23 @@ const SnkApplication = /*@__PURE__*/ proxyCustomElement(class extends HTMLElemen
789
789
  this._popUp.useHeader = false;
790
790
  }
791
791
  }
792
+ /**
793
+ * Exibe o conteúdo passado em um Modal.
794
+ */
792
795
  async showModal(content) {
793
796
  this.clearContent(this._rightModal);
794
797
  this._rightModal.appendChild(content);
795
798
  this._rightModal.opened = true;
796
799
  }
800
+ /**
801
+ * Fecha o Modal e limpa o conteúdo.
802
+ */
797
803
  async closeModal() {
798
804
  this.clearContent(this._rightModal);
799
805
  this._rightModal.opened = false;
800
806
  }
801
807
  /**
802
- * Fecha o popup, liberando o conteúdo.
808
+ * Fecha o Popup e limpa o conteúdo.
803
809
  */
804
810
  async closePopUp() {
805
811
  this.clearContent(this._popUp);
@@ -834,7 +840,7 @@ const SnkApplication = /*@__PURE__*/ proxyCustomElement(class extends HTMLElemen
834
840
  });
835
841
  }
836
842
  /**
837
- * Retorna a configuração de um recurso por service broker
843
+ * Obtém a configuração de um recurso por service broker
838
844
  */
839
845
  async getConfig(key) {
840
846
  let payload = {
@@ -875,13 +881,13 @@ const SnkApplication = /*@__PURE__*/ proxyCustomElement(class extends HTMLElemen
875
881
  });
876
882
  }
877
883
  /**
878
- * Acessa informações de contexto "empurrados" na abertura da tela
884
+ * Acessa informações de contexto "empurrados" na abertura da tela.
879
885
  */
880
886
  async getAttributeFromHTMLWrapper(attribName) {
881
887
  return Promise.resolve(window[attribName]);
882
888
  }
883
889
  /**
884
- * Abre determinada tela, repassando pkObject
890
+ * Abre determinada tela, repassando pkObject.
885
891
  */
886
892
  async openApp(resourceId, pkObject) {
887
893
  Workspace.openAppActivity(resourceId, pkObject);
@@ -899,7 +905,7 @@ const SnkApplication = /*@__PURE__*/ proxyCustomElement(class extends HTMLElemen
899
905
  }
900
906
  /**
901
907
  * Cria o DataUnit a partir do nome da entidade. É possível armazená-lo no cache
902
- * passando o dataUnitName, assim, se mais de uma chamada for feita, o mesmo DataUnit será usado
908
+ * passando o dataUnitName, assim, se mais de uma chamada for feita, o mesmo DataUnit será usado.
903
909
  */
904
910
  async createDataunit(entityName, dataUnitName) {
905
911
  return new Promise((resolve, reject) => {
@@ -940,31 +946,31 @@ const SnkApplication = /*@__PURE__*/ proxyCustomElement(class extends HTMLElemen
940
946
  });
941
947
  }
942
948
  /**
943
- * Retorna o resourceID da tela em questão.
949
+ * Obtém o resourceID da tela em questão.
944
950
  */
945
951
  async getResourceID() {
946
952
  return Promise.resolve(this.resourceID);
947
953
  }
948
954
  /**
949
- * Retorna o resourceID da tela em questão.
955
+ * Obtém o UserId da tela em questão.
950
956
  */
951
957
  async getUserID() {
952
958
  return Promise.resolve(window["UID"]);
953
959
  }
954
960
  /**
955
- * Mostra o diálogo de alerta de acordo com os parâmetros passados.
961
+ * Exibe o diálogo de alerta de acordo com os parâmetros passados.
956
962
  */
957
963
  async alert(title, message, icon, options) {
958
964
  return ApplicationUtils.alert(title, message, icon, options);
959
965
  }
960
966
  /**
961
- * Mostra o diálogo de erro de acordo com os parâmetros passados.
967
+ * Exibe o diálogo de erro de acordo com os parâmetros passados.
962
968
  */
963
969
  async error(title, message, icon, options) {
964
970
  return ApplicationUtils.error(title, message, icon, options);
965
971
  }
966
972
  /**
967
- * Mostra o diálogo de sucesso de acordo com os parâmetros passados.
973
+ * Exibe o diálogo de sucesso de acordo com os parâmetros passados.
968
974
  */
969
975
  async success(title, message, icon, options) {
970
976
  return ApplicationUtils.success(title, message, icon, options);
@@ -982,43 +988,43 @@ const SnkApplication = /*@__PURE__*/ proxyCustomElement(class extends HTMLElemen
982
988
  return ApplicationUtils.confirm(title, message, icon, dialogType, options);
983
989
  }
984
990
  /**
985
- * Mostra uma informação efêmera (de segundo plano).
991
+ * Exibe uma informação efêmera (de segundo plano).
986
992
  */
987
993
  async info(message, options) {
988
994
  return ApplicationUtils.info(message, options);
989
995
  }
990
996
  /**
991
- * Busca a configuração de formulário.
997
+ * Obtém a configuração de formulário.
992
998
  */
993
999
  async loadFormConfig(name) {
994
1000
  return this.formConfigFetcher.loadFormConfig(name, this.resourceID);
995
1001
  }
996
1002
  /**
997
- * Busca a configuração de grade.
1003
+ * Obtém a configuração de grade.
998
1004
  */
999
1005
  async loadGridConfig(name) {
1000
1006
  return this.gridConfigFetcher.getConfig(name, this.resourceID);
1001
1007
  }
1002
1008
  /**
1003
- * Busca lista de configurações de formulário do usuário.
1009
+ * Obtém a lista de configurações de formulário do usuário.
1004
1010
  */
1005
1011
  async fetchUserAvailableConfigs(name) {
1006
1012
  return this.formConfigFetcher.fetchUserAvailableConfigs(name, this.resourceID);
1007
1013
  }
1008
1014
  /**
1009
- * Busca a configuração de formulário do usuário.
1015
+ * Obtém a configuração de formulário do usuário.
1010
1016
  */
1011
1017
  async fetchLegacyConfig(name) {
1012
1018
  return this.formConfigFetcher.fetchLegacyConfig(name, this.resourceID);
1013
1019
  }
1014
1020
  /**
1015
- * Busca a configuração padrão de formulário.
1021
+ * Obtém a configuração padrão de formulário.
1016
1022
  */
1017
1023
  async fetchDefaultConfig(name) {
1018
1024
  return this.formConfigFetcher.fetchDefaultConfig(name, this.resourceID);
1019
1025
  }
1020
1026
  /**
1021
- * Busca os totalizadores da grade.
1027
+ * Obtém os totalizadores da grade.
1022
1028
  */
1023
1029
  async loadTotals(name, resourceID, filters) {
1024
1030
  return this.totalsFetcher.fetchTotals(name, resourceID, filters);
@@ -1062,13 +1068,13 @@ const SnkApplication = /*@__PURE__*/ proxyCustomElement(class extends HTMLElemen
1062
1068
  return this.formConfigFetcher.saveConfig(config, name, this.resourceID);
1063
1069
  }
1064
1070
  /**
1065
- * Busca um objeto com um conjunto de valores padrão.
1071
+ * Obtém um objeto com um conjunto de valores padrão.
1066
1072
  */
1067
1073
  async getDefaultValues() {
1068
1074
  return this.defaultValuesFetcher.getDefaultValues(this.resourceID);
1069
1075
  }
1070
1076
  /**
1071
- * Retorna um valor padrão específico de uma expressão.
1077
+ * Obtém um valor padrão específico de uma expressão.
1072
1078
  */
1073
1079
  async getDefaultValue(expression) {
1074
1080
  return this._defaultValues && this._defaultValues[expression];
@@ -1130,6 +1136,10 @@ const SnkApplication = /*@__PURE__*/ proxyCustomElement(class extends HTMLElemen
1130
1136
  }
1131
1137
  return this._defaultValuesFetcher;
1132
1138
  }
1139
+ /**
1140
+ * Obtém as opções em componentes de pesquisa
1141
+ * Ex.: snk-config-options
1142
+ */
1133
1143
  async executeSearch(searchArgument, fieldName, dataUnit) {
1134
1144
  const descriptor = dataUnit === null || dataUnit === void 0 ? void 0 : dataUnit.getField(fieldName);
1135
1145
  if (!descriptor) ;
@@ -1167,12 +1177,16 @@ const SnkApplication = /*@__PURE__*/ proxyCustomElement(class extends HTMLElemen
1167
1177
  return this.executePreparedSearch(mode, argument, { entity: ENTITYNAME, entityDescription: DESCRIPTIONENTITY, criteria, searchOptions });
1168
1178
  }
1169
1179
  }
1180
+ /**
1181
+ * Obtém as opções em componentes de pesquisa
1182
+ * Ex.: snk-config-options
1183
+ */
1170
1184
  async executePreparedSearch(mode, argument, options) {
1171
1185
  const { entity, entityDescription, criteria, searchOptions } = options;
1172
1186
  if (mode === "ADVANCED") {
1173
1187
  return new Promise(accept => {
1174
1188
  const pesquisaContent = document.createElement("snk-pesquisa");
1175
- pesquisaContent["data-element-id"] = `entity_${entity}`;
1189
+ pesquisaContent[ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME] = `entity_${entity}`;
1176
1190
  pesquisaContent.argument = argument;
1177
1191
  pesquisaContent.searchLoader = (text) => this.pesquisaFetcher.loadAdvancedSearch(entity, text, criteria, searchOptions);
1178
1192
  pesquisaContent.selectItem = (option) => {
@@ -1188,6 +1202,9 @@ const SnkApplication = /*@__PURE__*/ proxyCustomElement(class extends HTMLElemen
1188
1202
  return this.pesquisaFetcher.loadSearchOptions(entity, argument, criteria, searchOptions);
1189
1203
  }
1190
1204
  }
1205
+ /**
1206
+ * Obtém `true` caso a tela esteja em modo de debug.
1207
+ */
1191
1208
  async isDebugMode() {
1192
1209
  return new Promise(accept => {
1193
1210
  accept(window['isDebugMode']);
@@ -12,7 +12,7 @@ const SnkConfigOptions = /*@__PURE__*/ proxyCustomElement(class extends HTMLElem
12
12
  this.__registerHost();
13
13
  this.configOptionsChanged = createEvent(this, "configOptionsChanged", 7);
14
14
  /**
15
- * Armazena as propriedades do campo
15
+ * Armazena as propriedades do campo.
16
16
  */
17
17
  this.fieldConfig = {};
18
18
  }
@@ -19,10 +19,16 @@ const SnkConfigurator = /*@__PURE__*/ proxyCustomElement(class extends HTMLEleme
19
19
  */
20
20
  this.viewMode = GRID_MODE.name;
21
21
  }
22
+ /**
23
+ * Exibe a janela de configuração.
24
+ */
22
25
  async open() {
23
26
  this._opened = true;
24
27
  this.configSelected.emit(this.getViewModeValue());
25
28
  }
29
+ /**
30
+ * Fecha a janela de configuração.
31
+ */
26
32
  async close() {
27
33
  this.closeConfig();
28
34
  }
@@ -1,5 +1,5 @@
1
1
  import { proxyCustomElement, HTMLElement, createEvent, h } from '@stencil/core/internal/client';
2
- import { ApplicationContext, ElementIDUtils } from '@sankhyalabs/core';
2
+ import { ElementIDUtils, ApplicationContext } from '@sankhyalabs/core';
3
3
  import { V as VIEW_MODE } from './constants.js';
4
4
  import { T as TaskbarElement, d as defineCustomElement$2 } from './snk-taskbar2.js';
5
5
  import { d as defineCustomElement$g } from './snk-config-options2.js';
@@ -28,7 +28,7 @@ const SnkCrud$1 = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement {
28
28
  this.actionClick = createEvent(this, "actionClick", 7);
29
29
  this._viewMode = GRID_MODE.name;
30
30
  /**
31
- * Determina se pode haver mais de uma linha selecionada na grade
31
+ * Determina se pode haver mais de uma linha selecionada na grade.
32
32
  */
33
33
  this.multipleSelection = true;
34
34
  }
@@ -75,7 +75,7 @@ const SnkCrud$1 = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement {
75
75
  }
76
76
  }
77
77
  getDataElementId(suffix) {
78
- const elemIdSnkCrud = this._element.getAttribute("data-element-id");
78
+ const elemIdSnkCrud = this._element.getAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME);
79
79
  return `${elemIdSnkCrud}_${suffix}`;
80
80
  }
81
81
  componentWillLoad() {
@@ -15,7 +15,7 @@ const SnkDataUnit$1 = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement
15
15
  this.cancelEdition = createEvent(this, "cancelEdition", 7);
16
16
  this._onDataUnitResolve = [];
17
17
  /**
18
- * Determina quantas linhas são retornadas por página
18
+ * Determina quantas linhas são retornadas por página.
19
19
  */
20
20
  this.pageSize = 150;
21
21
  this._dataUnitObserver = (action) => {
@@ -88,9 +88,7 @@ const SnkDataUnit$1 = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement
88
88
  this.dataUnitReady.emit(this.dataUnit);
89
89
  }
90
90
  /**
91
- * Pode-se obter o dataUnit através desse método. Outra forma, é ouvir o evento de
92
- *
93
- * @returns dataUnit
91
+ * Obtém o dataUnit.
94
92
  */
95
93
  async getDataUnit() {
96
94
  return new Promise((resolve) => {
@@ -14,7 +14,7 @@ const SnkFieldConfig = /*@__PURE__*/ proxyCustomElement(class extends HTMLElemen
14
14
  */
15
15
  this.isConfigActive = false;
16
16
  /**
17
- * Define se o componente está em modo de inserção
17
+ * Define se o componente está em modo de inserção.
18
18
  */
19
19
  this.modeInsertion = true;
20
20
  }
@@ -31,7 +31,7 @@ const SnkFieldConfig = /*@__PURE__*/ proxyCustomElement(class extends HTMLElemen
31
31
  * Conforme mecanismo de mensagens, é possível customizar as mensagens dos blocos de construção
32
32
  * através de um pequeno modulo na estrutura da aplicação:
33
33
  * - Criar um arquivo no seguinte caminho: /messages/appmessages.msg.js.
34
- * Para conhecer os detalhes do módulo, vide o arquivo neste projeto "/src/lib/message/resources/snk-form.msg.ts"
34
+ * Para conhecer os detalhes do módulo, vide o arquivo neste projeto "/src/lib/message/resources/snk-form.msg.ts".
35
35
  */
36
36
  getMessage(key) {
37
37
  return this._application.messagesBuilder.getMessage(key, {});
@@ -160,7 +160,7 @@ const SnkFilterBar = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement
160
160
  if (this._element) {
161
161
  const dataInfo = { dataUnit: this.dataUnit };
162
162
  ElementIDUtils.addIDInfo(this._element, null, dataInfo);
163
- const dataElementIdFilterBar = this._element.getAttribute("data-element-id");
163
+ const dataElementIdFilterBar = this._element.getAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME);
164
164
  this._idSnkFilterItem = dataElementIdFilterBar;
165
165
  this._idSnkFilterList = dataElementIdFilterBar;
166
166
  }
@@ -432,6 +432,9 @@ const SnkFilterBar = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement
432
432
  this.registryFilterProvider();
433
433
  }
434
434
  }
435
+ /**
436
+ * Emitido quando acontece a alteração do estado do filtro.
437
+ */
435
438
  filterChangeListener(evt) {
436
439
  this.updateFilter(evt.detail);
437
440
  }
@@ -10,6 +10,9 @@ const SnkFilterBinarySelect$1 = /*@__PURE__*/ proxyCustomElement(class extends H
10
10
  isSelected(option) {
11
11
  return this.value == undefined || this.value === option;
12
12
  }
13
+ /**
14
+ * Emitido quando acontece a alteração de valor do componente snk-filter-binary-select
15
+ */
13
16
  ezChangeListener(evt) {
14
17
  if (!evt.detail) {
15
18
  this.assertCheckedOption(evt.target);
@@ -38,6 +41,9 @@ const SnkFilterBinarySelect$1 = /*@__PURE__*/ proxyCustomElement(class extends H
38
41
  this.value = undefined;
39
42
  }
40
43
  }
44
+ /**
45
+ * Exibe o componente snk-filter-binary-select
46
+ */
41
47
  async show() {
42
48
  this._checkOne.setFocus();
43
49
  }
@@ -9,13 +9,16 @@ const SnkFilterDetail = /*@__PURE__*/ proxyCustomElement(class extends HTMLEleme
9
9
  this.__registerHost();
10
10
  this.filterChange = createEvent(this, "filterChange", 7);
11
11
  }
12
+ /**
13
+ * Exibe o componente snk-filter-detail.
14
+ */
12
15
  async show() {
13
16
  this._editor["show"]();
14
17
  }
15
18
  componentDidLoad() {
16
19
  if (this._element) {
17
20
  ElementIDUtils.addIDInfo(this._element);
18
- const dataElementIdDoFilterItem = this._element.getAttribute("data-element-id");
21
+ const dataElementIdDoFilterItem = this._element.getAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME);
19
22
  this._idContentEditor = `${dataElementIdDoFilterItem}_${this.config.id}`;
20
23
  }
21
24
  }