@sankhyalabs/sankhyablocks-docs 3.6.1 → 4.0.0

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 (11) hide show
  1. package/components/snk-application/readme.md +10 -70
  2. package/components/snk-configurator/readme.md +10 -8
  3. package/components/snk-crud/readme.md +15 -4
  4. package/components/snk-crud/subcomponents/readme.md +95 -0
  5. package/components/snk-data-exporter/readme.md +4 -0
  6. package/components/snk-data-unit/readme.md +15 -0
  7. package/components/snk-form/readme.md +4 -16
  8. package/components/snk-form/subcomponents/snk-form-config/readme.md +6 -5
  9. package/components/snk-grid/readme.md +2 -0
  10. package/components/snk-taskbar/readme.md +4 -2
  11. package/package.json +1 -1
package/components/snk-application/readme.md CHANGED
@@ -106,36 +106,6 @@ Type: `Promise<IOption | IOption[]>`
106
106
 
107
107
 
108
108
 
109
- ### `fetchDefaultConfig(name: string) => Promise<IFormConfig>`
110
-
111
- Obtém a configuração padrão de formulário.
112
-
113
- #### Returns
114
-
115
- Type: `Promise<IFormConfig>`
116
-
117
-
118
-
119
- ### `fetchLegacyConfig(name: string) => Promise<IFormConfig>`
120
-
121
- Obtém a configuração de formulário do usuário.
122
-
123
- #### Returns
124
-
125
- Type: `Promise<IFormConfig>`
126
-
127
-
128
-
129
- ### `fetchUserAvailableConfigs(name: string) => Promise<Array<IUserConfig>>`
130
-
131
- Obtém a lista de configurações de formulário do usuário.
132
-
133
- #### Returns
134
-
135
- Type: `Promise<IUserConfig[]>`
136
-
137
-
138
-
139
109
  ### `getAllAccess() => Promise<any>`
140
110
 
141
111
  Obtém todos os acessos do usuário logado.
@@ -206,26 +176,6 @@ Type: `Promise<Date>`
206
176
 
207
177
 
208
178
 
209
- ### `getDefaultValue(expression: string) => Promise<any>`
210
-
211
- Obtém um valor padrão específico de uma expressão.
212
-
213
- #### Returns
214
-
215
- Type: `Promise<any>`
216
-
217
-
218
-
219
- ### `getDefaultValues() => Promise<string>`
220
-
221
- Obtém um objeto com um conjunto de valores padrão.
222
-
223
- #### Returns
224
-
225
- Type: `Promise<string>`
226
-
227
-
228
-
229
179
  ### `getFloatParam(name: string) => Promise<number>`
230
180
 
231
181
  Obtém o valor de um parâmetro do tipo Decimal.
@@ -316,16 +266,6 @@ Type: `Promise<boolean>`
316
266
 
317
267
 
318
268
 
319
- ### `loadFormConfig(name: string) => Promise<IFormConfig>`
320
-
321
- Obtém a configuração de formulário.
322
-
323
- #### Returns
324
-
325
- Type: `Promise<IFormConfig>`
326
-
327
-
328
-
329
269
  ### `loadGridConfig(name: string) => Promise<IGridConfig>`
330
270
 
331
271
  Obtém a configuração de grade.
@@ -376,16 +316,6 @@ Type: `Promise<any>`
376
316
 
377
317
 
378
318
 
379
- ### `saveFormConfig(config: IFormConfig, name: string) => Promise<IFormConfig>`
380
-
381
- Salva a configuração de formulário.
382
-
383
- #### Returns
384
-
385
- Type: `Promise<IFormConfig>`
386
-
387
-
388
-
389
319
  ### `showModal(content: HTMLElement) => Promise<void>`
390
320
 
391
321
  Exibe o conteúdo passado em um Modal.
@@ -426,6 +356,16 @@ Type: `Promise<boolean>`
426
356
 
427
357
 
428
358
 
359
+ ### `updateDataunitCache(oldName: string, dataUnitName: string, dataUnit: DataUnit) => Promise<void>`
360
+
361
+ Atualiza o cache de dataunits da aplicação.
362
+
363
+ #### Returns
364
+
365
+ Type: `Promise<void>`
366
+
367
+
368
+
429
369
  ### `webConnection(keyPort: string, methodName: string, params: IAppletCallerParams) => Promise<void>`
430
370
 
431
371
  Realiza a chamada do WebConnection para realizar a exportação de arquivo.
package/components/snk-configurator/readme.md CHANGED
@@ -7,18 +7,18 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------ | ------------- | --------------------------------------------------------------- | -------- | ---------------- |
12
- | `configName` | `config-name` | Usado para guardar ou recuperar as configurações do formulário. | `string` | `undefined` |
13
- | `viewMode` | `view-mode` | Define qual modo de visualização está ativo. | `string` | `GRID_MODE.name` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------ | ------------- | --------------------------------------------------------------- | ---------------------------------- | ---------------- |
12
+ | `configName` | `config-name` | Usado para guardar ou recuperar as configurações do formulário. | `string` | `undefined` |
13
+ | `viewMode` | `view-mode` | Define qual modo de visualização está ativo. | `VIEW_MODE.FORM \| VIEW_MODE.GRID` | `VIEW_MODE.GRID` |
14
14
 
15
15
 
16
16
  ## Events
17
17
 
18
- | Event | Description | Type |
19
- | ---------------- | ------------------------------------------------ | --------------------- |
20
- | `configSelected` | Emitido quando seleciona o modo de visualização. | `CustomEvent<string>` |
21
- | `openConfig` | Emitido quando clica para abrir a configuração. | `CustomEvent<string>` |
18
+ | Event | Description | Type |
19
+ | ---------------- | ------------------------------------------------ | ----------------------------------------------- |
20
+ | `configSelected` | Emitido quando seleciona o modo de visualização. | `CustomEvent<VIEW_MODE.FORM \| VIEW_MODE.GRID>` |
21
+ | `openConfig` | Emitido quando clica para abrir a configuração. | `CustomEvent<VIEW_MODE.FORM \| VIEW_MODE.GRID>` |
22
22
 
23
23
 
24
24
  ## Methods
@@ -49,11 +49,13 @@ Type: `Promise<void>`
49
49
  ### Used by
50
50
 
51
51
  - [snk-crud](../snk-crud)
52
+ - [snk-guides-viewer](../snk-crud/subcomponents)
52
53
 
53
54
  ### Graph
54
55
  ```mermaid
55
56
  graph TD;
56
57
  snk-crud --> snk-configurator
58
+ snk-guides-viewer --> snk-configurator
57
59
  style snk-configurator fill:#f9f,stroke:#333,stroke-width:4px
58
60
  ```
59
61
 
package/components/snk-crud/readme.md CHANGED
@@ -43,7 +43,7 @@ Type: `Promise<void>`
43
43
  ### Depends on
44
44
 
45
45
  - [snk-grid](../snk-grid)
46
- - [snk-form](../snk-form)
46
+ - [snk-guides-viewer](subcomponents)
47
47
  - [snk-configurator](../snk-configurator)
48
48
  - [snk-data-exporter](../snk-data-exporter)
49
49
 
@@ -51,7 +51,7 @@ Type: `Promise<void>`
51
51
  ```mermaid
52
52
  graph TD;
53
53
  snk-crud --> snk-grid
54
- snk-crud --> snk-form
54
+ snk-crud --> snk-guides-viewer
55
55
  snk-crud --> snk-configurator
56
56
  snk-crud --> snk-data-exporter
57
57
  snk-grid --> snk-filter-bar
@@ -64,8 +64,19 @@ graph TD;
64
64
  snk-taskbar --> snk-data-exporter
65
65
  snk-data-exporter --> snk-exporter-email-sender
66
66
  snk-grid-config --> snk-select-box
67
- snk-form --> snk-taskbar
68
- snk-form --> snk-form-config
67
+ snk-guides-viewer --> snk-form-view
68
+ snk-guides-viewer --> snk-data-unit
69
+ snk-guides-viewer --> snk-detail-view
70
+ snk-guides-viewer --> snk-form-config
71
+ snk-guides-viewer --> snk-taskbar
72
+ snk-guides-viewer --> snk-configurator
73
+ snk-guides-viewer --> snk-data-exporter
74
+ snk-form-view --> snk-form-summary
75
+ snk-detail-view --> snk-data-unit
76
+ snk-detail-view --> snk-grid
77
+ snk-detail-view --> snk-form-view
78
+ snk-detail-view --> snk-taskbar
79
+ snk-detail-view --> snk-data-exporter
69
80
  snk-form-config --> snk-field-config
70
81
  snk-form-config --> snk-config-options
71
82
  snk-form-config --> snk-tab-config
package/components/snk-crud/subcomponents/readme.md ADDED
@@ -0,0 +1,95 @@
1
+ # snk-guides-viewer
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------ | ------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------ | ----------- |
12
+ | `actionsList` | -- | Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
13
+ | `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário. | `string` | `undefined` |
14
+ | `dataState` | -- | Representa o estado do dataUnit master. | `DataState` | `undefined` |
15
+ | `dataUnit` | -- | Instância do DataUnit master. | `DataUnit` | `undefined` |
16
+ | `entityPath` | `entity-path` | Determina todo o caminho de entidades. | `string` | `undefined` |
17
+ | `masterFormConfig` | -- | Configuração do formulário master. | `IFormConfig` | `undefined` |
18
+ | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
19
+ | `selectedGuide` | -- | Guia selecionada. | `IGuideItem` | `undefined` |
20
+ | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
21
+
22
+
23
+ ## Events
24
+
25
+ | Event | Description | Type |
26
+ | ------------- | ------------------------------------------------- | --------------------- |
27
+ | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
28
+ | `exit` | Emitido quando o botão de voltar é acionado. | `CustomEvent<void>` |
29
+
30
+
31
+ ## Methods
32
+
33
+ ### `showFormConfig(detail?: boolean) => Promise<void>`
34
+
35
+ Abre o configurador do formulário
36
+
37
+ #### Returns
38
+
39
+ Type: `Promise<void>`
40
+
41
+
42
+
43
+
44
+ ## Dependencies
45
+
46
+ ### Used by
47
+
48
+ - [snk-crud](..)
49
+
50
+ ### Depends on
51
+
52
+ - [snk-form-view](.)
53
+ - [snk-data-unit](../../snk-data-unit)
54
+ - [snk-detail-view](.)
55
+ - [snk-form-config](../../snk-form/subcomponents/snk-form-config)
56
+ - [snk-taskbar](../../snk-taskbar)
57
+ - [snk-configurator](../../snk-configurator)
58
+ - [snk-data-exporter](../../snk-data-exporter)
59
+
60
+ ### Graph
61
+ ```mermaid
62
+ graph TD;
63
+ snk-guides-viewer --> snk-form-view
64
+ snk-guides-viewer --> snk-data-unit
65
+ snk-guides-viewer --> snk-detail-view
66
+ snk-guides-viewer --> snk-form-config
67
+ snk-guides-viewer --> snk-taskbar
68
+ snk-guides-viewer --> snk-configurator
69
+ snk-guides-viewer --> snk-data-exporter
70
+ snk-form-view --> snk-form-summary
71
+ snk-detail-view --> snk-data-unit
72
+ snk-detail-view --> snk-grid
73
+ snk-detail-view --> snk-form-view
74
+ snk-detail-view --> snk-taskbar
75
+ snk-detail-view --> snk-data-exporter
76
+ snk-grid --> snk-filter-bar
77
+ snk-grid --> snk-taskbar
78
+ snk-grid --> snk-grid-config
79
+ snk-filter-bar --> snk-filter-item
80
+ snk-filter-bar --> snk-filter-modal
81
+ snk-filter-bar --> snk-filter-list
82
+ snk-filter-item --> snk-filter-detail
83
+ snk-taskbar --> snk-data-exporter
84
+ snk-data-exporter --> snk-exporter-email-sender
85
+ snk-grid-config --> snk-select-box
86
+ snk-form-config --> snk-field-config
87
+ snk-form-config --> snk-config-options
88
+ snk-form-config --> snk-tab-config
89
+ snk-crud --> snk-guides-viewer
90
+ style snk-guides-viewer fill:#f9f,stroke:#333,stroke-width:4px
91
+ ```
92
+
93
+ ----------------------------------------------
94
+
95
+
package/components/snk-data-exporter/readme.md CHANGED
@@ -17,6 +17,8 @@
17
17
  ### Used by
18
18
 
19
19
  - [snk-crud](../snk-crud)
20
+ - [snk-detail-view](../snk-crud/subcomponents)
21
+ - [snk-guides-viewer](../snk-crud/subcomponents)
20
22
  - [snk-taskbar](../snk-taskbar)
21
23
 
22
24
  ### Depends on
@@ -28,6 +30,8 @@
28
30
  graph TD;
29
31
  snk-data-exporter --> snk-exporter-email-sender
30
32
  snk-crud --> snk-data-exporter
33
+ snk-detail-view --> snk-data-exporter
34
+ snk-guides-viewer --> snk-data-exporter
31
35
  snk-taskbar --> snk-data-exporter
32
36
  style snk-data-exporter fill:#f9f,stroke:#333,stroke-width:4px
33
37
  ```
package/components/snk-data-unit/readme.md CHANGED
@@ -51,6 +51,21 @@ Type: `Promise<IRecordID[]>`
51
51
  Retorna a lista de IDs dos registros selecionados.
52
52
 
53
53
 
54
+ ## Dependencies
55
+
56
+ ### Used by
57
+
58
+ - [snk-detail-view](../snk-crud/subcomponents)
59
+ - [snk-guides-viewer](../snk-crud/subcomponents)
60
+
61
+ ### Graph
62
+ ```mermaid
63
+ graph TD;
64
+ snk-detail-view --> snk-data-unit
65
+ snk-guides-viewer --> snk-data-unit
66
+ style snk-data-unit fill:#f9f,stroke:#333,stroke-width:4px
67
+ ```
68
+
54
69
  ----------------------------------------------
55
70
 
56
71
 
package/components/snk-form/readme.md CHANGED
@@ -7,13 +7,10 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------ | ------------------- | ------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | -------------------------- |
12
- | `actionsList` | -- | Define a lista de ações que devem ser usadas no botão "Mais opções" do snk-taskbar. | `Action[]` | `undefined` |
13
- | `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário. | `string` | `undefined` |
14
- | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY` | `PresentationMode.PRIMARY` |
15
- | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
16
- | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------ | ------------- | --------------------------------------------------------------------------- | ------------------ | ----------- |
12
+ | `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário. | `string` | `undefined` |
13
+ | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
17
14
 
18
15
 
19
16
  ## Events
@@ -49,26 +46,17 @@ Type: `Promise<void>`
49
46
 
50
47
  ## Dependencies
51
48
 
52
- ### Used by
53
-
54
- - [snk-crud](../snk-crud)
55
-
56
49
  ### Depends on
57
50
 
58
- - [snk-taskbar](../snk-taskbar)
59
51
  - [snk-form-config](./subcomponents/snk-form-config)
60
52
 
61
53
  ### Graph
62
54
  ```mermaid
63
55
  graph TD;
64
- snk-form --> snk-taskbar
65
56
  snk-form --> snk-form-config
66
- snk-taskbar --> snk-data-exporter
67
- snk-data-exporter --> snk-exporter-email-sender
68
57
  snk-form-config --> snk-field-config
69
58
  snk-form-config --> snk-config-options
70
59
  snk-form-config --> snk-tab-config
71
- snk-crud --> snk-form
72
60
  style snk-form fill:#f9f,stroke:#333,stroke-width:4px
73
61
  ```
74
62
 
package/components/snk-form/subcomponents/snk-form-config/readme.md CHANGED
@@ -7,11 +7,10 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------ | ------------- | -------------------------------------------------------------------- | ------------- | ------------------- |
12
- | `configName` | `config-name` | Nome usado para guardar ou recuperar as configurações do formulário. | `string` | `undefined` |
13
- | `dataUnit` | -- | Repositório de dados, controla a manipulação dos dados. | `DataUnit` | `undefined` |
14
- | `formConfig` | -- | Campos de configuração de formulário. | `IFormConfig` | `{} as IFormConfig` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | --------------- | --------- | ------------------------------------------------------- | ---------------------- | ----------- |
12
+ | `configManager` | -- | Campos de configuração de formulário. | `SnkFormConfigManager` | `undefined` |
13
+ | `dataUnit` | -- | Repositório de dados, controla a manipulação dos dados. | `DataUnit` | `undefined` |
15
14
 
16
15
 
17
16
  ## Events
@@ -27,6 +26,7 @@
27
26
  ### Used by
28
27
 
29
28
  - [snk-form](../..)
29
+ - [snk-guides-viewer](../../../snk-crud/subcomponents)
30
30
 
31
31
  ### Depends on
32
32
 
@@ -41,6 +41,7 @@ graph TD;
41
41
  snk-form-config --> snk-config-options
42
42
  snk-form-config --> snk-tab-config
43
43
  snk-form --> snk-form-config
44
+ snk-guides-viewer --> snk-form-config
44
45
  style snk-form-config fill:#f9f,stroke:#333,stroke-width:4px
45
46
  ```
46
47
 
package/components/snk-grid/readme.md CHANGED
@@ -63,6 +63,7 @@ Type: `Promise<void>`
63
63
  ### Used by
64
64
 
65
65
  - [snk-crud](../snk-crud)
66
+ - [snk-detail-view](../snk-crud/subcomponents)
66
67
 
67
68
  ### Depends on
68
69
 
@@ -84,6 +85,7 @@ graph TD;
84
85
  snk-data-exporter --> snk-exporter-email-sender
85
86
  snk-grid-config --> snk-select-box
86
87
  snk-crud --> snk-grid
88
+ snk-detail-view --> snk-grid
87
89
  style snk-grid fill:#f9f,stroke:#333,stroke-width:4px
88
90
  ```
89
91
 
package/components/snk-taskbar/readme.md CHANGED
@@ -30,8 +30,9 @@
30
30
 
31
31
  ### Used by
32
32
 
33
- - [snk-form](../snk-form)
33
+ - [snk-detail-view](../snk-crud/subcomponents)
34
34
  - [snk-grid](../snk-grid)
35
+ - [snk-guides-viewer](../snk-crud/subcomponents)
35
36
 
36
37
  ### Depends on
37
38
 
@@ -42,8 +43,9 @@
42
43
  graph TD;
43
44
  snk-taskbar --> snk-data-exporter
44
45
  snk-data-exporter --> snk-exporter-email-sender
45
- snk-form --> snk-taskbar
46
+ snk-detail-view --> snk-taskbar
46
47
  snk-grid --> snk-taskbar
48
+ snk-guides-viewer --> snk-taskbar
47
49
  style snk-taskbar fill:#f9f,stroke:#333,stroke-width:4px
48
50
  ```
49
51
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "3.6.1",
3
+ "version": "4.0.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [