@sankhyalabs/sankhyablocks-docs 2.0.0

package/components/snk-application/readme.md

@@ -0,0 +1,468 @@
+# snk-application
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property          | Attribute     | Description                                                                                                            | Type                | Default     |
+| ----------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------------- | ----------- |
+| `configName`      | `config-name` | Usado para salvar as configurações dos blocos de construção.                                                           | `string`            | `undefined` |
+| `messagesBuilder` | --            | messagesBuilder é um utilitário responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
+
+
+## Events
+
+| Event                | Description                                        | Type                   |
+| -------------------- | -------------------------------------------------- | ---------------------- |
+| `applicationLoaded`  | Evento disparado quando a aplicação for carregada. | `CustomEvent<boolean>` |
+| `applicationLoading` | Evento disparado ao iniciar a carga do componente  | `CustomEvent<boolean>` |
+
+
+## Methods
+
+### `alert(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
+
+Mostra o diálogo de alerta de acordo com os parâmetros passados.
+
+#### Returns
+
+Type: `Promise<boolean>`
+
+
+
+### `closeModal() => Promise<void>`
+
+
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `closePopUp() => Promise<void>`
+
+Fecha o popup, liberando o conteúdo.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `confirm(title: string, message: string, icon?: string, dialogType?: DialogType, options?: MessageOptions) => Promise<boolean>`
+
+Exibe um diálogo de confirmação
+
+#### Returns
+
+Type: `Promise<boolean>`
+
+
+
+### `createDataunit(entityName: string, dataUnitName?: string) => Promise<DataUnit>`
+
+Cria o DataUnit a partir do nome da entidade. É possível armazená-lo no cache
+passando o dataUnitName, assim, se mais de uma chamada for feita, o mesmo DataUnit será usado
+
+#### Returns
+
+Type: `Promise<DataUnit>`
+
+
+
+### `error(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
+
+Mostra o diálogo de erro de acordo com os parâmetros passados.
+
+#### Returns
+
+Type: `Promise<boolean>`
+
+
+
+### `executePreparedSearch(mode: string, argument: string, options: any) => Promise<Array<IOption> | IOption>`
+
+
+
+#### Returns
+
+Type: `Promise<IOption | IOption[]>`
+
+
+
+### `executeSearch(searchArgument: ISearchArgument, fieldName: string, dataUnit: DataUnit) => Promise<Array<IOption> | IOption>`
+
+
+
+#### Returns
+
+Type: `Promise<IOption | IOption[]>`
+
+
+
+### `fetchDefaultConfig(name: string) => Promise<IFormConfig>`
+
+Busca a configuração padrão de formulário.
+
+#### Returns
+
+Type: `Promise<IFormConfig>`
+
+
+
+### `fetchLegacyConfig(name: string) => Promise<IFormConfig>`
+
+Busca a configuração de formulário do usuário.
+
+#### Returns
+
+Type: `Promise<IFormConfig>`
+
+
+
+### `fetchUserAvailableConfigs(name: string) => Promise<Array<IUserConfig>>`
+
+Busca lista de configurações de formulário do usuário.
+
+#### Returns
+
+Type: `Promise<IUserConfig[]>`
+
+
+
+### `getAllAccess() => Promise<any>`
+
+Retorna todos os acessos do usuário logado.
+
+#### Returns
+
+Type: `Promise<any>`
+
+
+
+### `getAttributeFromHTMLWrapper(attribName: string) => Promise<string>`
+
+Acessa informações de contexto "empurrados" na abertura da tela
+
+#### Returns
+
+Type: `Promise<string>`
+
+
+
+### `getBooleanParam(name: string) => Promise<boolean>`
+
+Retorna o valor de um parâmetro do tipo booleano.
+
+#### Returns
+
+Type: `Promise<boolean>`
+
+
+
+### `getConfig(key: string) => Promise<any>`
+
+Retorna a configuração de um recurso por service broker
+
+#### Returns
+
+Type: `Promise<any>`
+
+
+
+### `getDataUnit(entityName: string, dataUnitName: string) => Promise<DataUnit>`
+
+Obtem um DataUnit do cache ou cria um caso ainda não tenha sido criado.
+
+#### Returns
+
+Type: `Promise<DataUnit>`
+
+
+
+### `getDateParam(name: string) => Promise<Date>`
+
+Retorna o valor de um parâmetro do tipo data.
+
+#### Returns
+
+Type: `Promise<Date>`
+
+
+
+### `getDefaultValue(expression: string) => Promise<any>`
+
+Retorna um valor padrão específico de uma expressão.
+
+#### Returns
+
+Type: `Promise<any>`
+
+
+
+### `getDefaultValues() => Promise<string>`
+
+Busca um objeto com um conjunto de valores padrão.
+
+#### Returns
+
+Type: `Promise<string>`
+
+
+
+### `getFilterBarConfig(name: string) => Promise<Array<SnkFilterItemConfig>>`
+
+Obtém as configurações da barra de filtros
+
+#### Returns
+
+Type: `Promise<SnkFilterItemConfig[]>`
+
+
+
+### `getFloatParam(name: string) => Promise<number>`
+
+Retorna o valor de um parâmetro do tipo Decimal.
+
+#### Returns
+
+Type: `Promise<number>`
+
+
+
+### `getIntParam(name: string) => Promise<number>`
+
+Retorna o valor de um parâmetro do tipo Inteiro.
+
+#### Returns
+
+Type: `Promise<number>`
+
+
+
+### `getResourceID() => Promise<string>`
+
+Retorna o resourceID da tela em questão.
+
+#### Returns
+
+Type: `Promise<string>`
+
+
+
+### `getStringParam(name: string) => Promise<string>`
+
+Retorna o valor de um parâmetro do tipo string.
+
+#### Returns
+
+Type: `Promise<string>`
+
+
+
+### `getUserID() => Promise<string>`
+
+Retorna o resourceID da tela em questão.
+
+#### Returns
+
+Type: `Promise<string>`
+
+
+
+### `hasAccess(access: AutorizationType) => Promise<boolean>`
+
+Se o usuário logado tem permissão pra determinada ação.
+
+#### Returns
+
+Type: `Promise<boolean>`
+
+
+
+### `info(message: string, options?: MessageOptions) => Promise<void>`
+
+Mostra uma informação efêmera (de segundo plano).
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `isDebugMode() => Promise<boolean>`
+
+
+
+#### Returns
+
+Type: `Promise<boolean>`
+
+
+
+### `isUserSup() => Promise<boolean>`
+
+Caso o usuário logado seja o SUP.
+
+#### Returns
+
+Type: `Promise<boolean>`
+
+
+
+### `loadFormConfig(name: string) => Promise<IFormConfig>`
+
+Busca a configuração de formulário.
+
+#### Returns
+
+Type: `Promise<IFormConfig>`
+
+
+
+### `loadGridConfig(name: string) => Promise<IGridConfig>`
+
+Busca a configuração de grade.
+
+#### Returns
+
+Type: `Promise<IGridConfig>`
+
+
+
+### `loadTotals(name: string, resourceID: string, filters: Array<Filter>) => Promise<Map<string, number>>`
+
+Busca os totalizadores da grade.
+
+#### Returns
+
+Type: `Promise<Map<string, number>>`
+
+
+
+### `message(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
+
+Exibe um diálogo de mensagem comum
+
+#### Returns
+
+Type: `Promise<boolean>`
+
+
+
+### `openApp(resourceId: string, pkObject: Object) => Promise<void>`
+
+Abre determinada tela, repassando pkObject
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `saveConfig(key: string, data: Object) => Promise<any>`
+
+Salva a configuração de determinado recurso.
+
+#### Returns
+
+Type: `Promise<any>`
+
+
+
+### `saveFilterBarConfig(config: Array<SnkFilterItemConfig>, name: string) => Promise<boolean>`
+
+Salva as configurações da barra de filtros
+
+#### Returns
+
+Type: `Promise<boolean>`
+
+
+
+### `saveFormConfig(config: IFormConfig, name: string) => Promise<boolean>`
+
+Salva a configuração de formulário.
+
+#### Returns
+
+Type: `Promise<boolean>`
+
+
+
+### `saveGridConfig(config: IGridConfig) => Promise<boolean>`
+
+Salva a configuração de grade.
+
+#### Returns
+
+Type: `Promise<boolean>`
+
+
+
+### `showModal(content: HTMLElement) => Promise<void>`
+
+
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `showPopUp(content: HTMLElement, size?: string, useHeader?: boolean) => Promise<void>`
+
+Mostra o conteúdo passado em um Popup
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `success(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
+
+Mostra o diálogo de sucesso de acordo com os parâmetros passados.
+
+#### Returns
+
+Type: `Promise<boolean>`
+
+
+
+### `temOpcional(opcional: string) => Promise<boolean>`
+
+Verifica se a licença do cliente tem determinado opcional (produto)
+
+#### Returns
+
+Type: `Promise<boolean>`
+
+
+
+
+## Dependencies
+
+### Used by
+
+ - [teste-pesquisa](../teste-pesquisa)
+
+### Depends on
+
+- [snk-pesquisa](../snk-pesquisa)
+
+### Graph
+```mermaid
+graph TD;
+  snk-application --> snk-pesquisa
+  teste-pesquisa --> snk-application
+  style snk-application fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/snk-configurator/readme.md

@@ -0,0 +1,62 @@
+# snk-configurator
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property     | Attribute     | Description                                                      | Type     | Default          |
+| ------------ | ------------- | ---------------------------------------------------------------- | -------- | ---------------- |
+| `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário | `string` | `undefined`      |
+| `viewMode`   | `view-mode`   | Define qual modo de visualização está ativo.                     | `string` | `GRID_MODE.name` |
+
+
+## Events
+
+| Event            | Description                                                | Type                  |
+| ---------------- | ---------------------------------------------------------- | --------------------- |
+| `configSelected` | Evento disparado quando seleciona modo de visualização     | `CustomEvent<string>` |
+| `openConfig`     | Evento disparado quando clicar para abrir uma configuração | `CustomEvent<string>` |
+
+
+## Methods
+
+### `close() => Promise<void>`
+
+
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `open() => Promise<void>`
+
+
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+## Dependencies
+
+### Used by
+
+ - [snk-crud](../snk-crud)
+
+### Graph
+```mermaid
+graph TD;
+  snk-crud --> snk-configurator
+  style snk-configurator fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/snk-crud/readme.md

@@ -0,0 +1,72 @@
+# snk-crud
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property            | Attribute            | Description                                                                                                         | Type               | Default     |
+| ------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------ | ----------- |
+| `actionsList`       | --                   | Ações a serem colocadas no botão "Mais opções".                                                                     | `Action[]`         | `undefined` |
+| `configName`        | `config-name`        | Usado para salvar as configurações dos blocos de construção.                                                        | `string`           | `undefined` |
+| `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade                                                      | `boolean`          | `true`      |
+| `recordsValidator`  | --                   | Validador responsável por checar a integridade das informações do registro                                          | `IRecordValidator` | `undefined` |
+| `statusResolver`    | --                   | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }            | `IStatusResolver`  | `undefined` |
+| `taskbarManager`    | --                   | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager`   | `undefined` |
+
+
+## Events
+
+| Event         | Description                                                   | Type                  |
+| ------------- | ------------------------------------------------------------- | --------------------- |
+| `actionClick` | Emitido pela taskbar sempre que houver click de botão ou ação | `CustomEvent<string>` |
+
+
+## Methods
+
+### `goToView(mode: string) => Promise<void>`
+
+Usado para alternar a visão entre GRID e FORM externamente.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+## Dependencies
+
+### Depends on
+
+- [snk-grid](../snk-grid)
+- [snk-form](../snk-form)
+- [snk-configurator](../snk-configurator)
+
+### Graph
+```mermaid
+graph TD;
+  snk-crud --> snk-grid
+  snk-crud --> snk-form
+  snk-crud --> snk-configurator
+  snk-grid --> snk-filter-bar
+  snk-grid --> snk-taskbar
+  snk-grid --> snk-grid-config
+  snk-filter-bar --> snk-filter-item
+  snk-filter-bar --> snk-filter-modal
+  snk-filter-bar --> snk-filter-list
+  snk-filter-item --> snk-filter-detail
+  snk-grid-config --> snk-select-box
+  snk-form --> snk-taskbar
+  snk-form --> snk-form-config
+  snk-form-config --> snk-field-config
+  snk-form-config --> snk-config-options
+  snk-form-config --> snk-tab-config
+  style snk-crud fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/snk-data-unit/readme.md

@@ -0,0 +1,46 @@
+# snk-data-unit
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property       | Attribute        | Description                                                                                                                                                                        | Type                                                  | Default     |
+| -------------- | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | ----------- |
+| `afterSave`    | --               | Executado após a ação de salvar                                                                                                                                                    | `(dataUnit: DataUnit) => void`                        | `undefined` |
+| `beforeSave`   | --               | Executado imediatamente antes da ação de salvar as alterações. Útil no caso de validações por exemplo. Caso retorne "false" (ou a promessa se resolva como false), cancela a ação. | `(dataUnit: DataUnit) => boolean \| Promise<boolean>` | `undefined` |
+| `dataState`    | --               | O estato atual dos dados, isto é se há alteração, insersão, as linhas selecionadas, etc.                                                                                           | `DataState`                                           | `undefined` |
+| `dataUnit`     | --               | Uma vez instanciado, pode-se obter o dataUnit por esta propriedade                                                                                                                 | `DataUnit`                                            | `undefined` |
+| `dataUnitName` | `data-unit-name` | Este atributo é usado para criar o dataUnit uma única vez. Se omitido será usado o próprio nome da entidade.                                                                       | `string`                                              | `undefined` |
+| `entityName`   | `entity-name`    | Determina qual a entidade representa os dados em questão.                                                                                                                          | `string`                                              | `undefined` |
+| `pageSize`     | `page-size`      | Determina quantas linhas são retornadas por página                                                                                                                                 | `number`                                              | `150`       |
+
+
+## Events
+
+| Event             | Description                                                  | Type                     |
+| ----------------- | ------------------------------------------------------------ | ------------------------ |
+| `cancelEdition`   | Disparado quando se cancela uma insersão/cópia               | `CustomEvent<void>`      |
+| `dataStateChange` | Disparado quando o há qualquer mudança de estado no DataUnit | `CustomEvent<DataState>` |
+| `dataUnitReady`   | Disparado quando o DataUnit está pronto                      | `CustomEvent<DataUnit>`  |
+| `insertionMode`   | Disparado quando um registro é adicionado ou copiado         | `CustomEvent<void>`      |
+
+
+## Methods
+
+### `getDataUnit() => Promise<DataUnit>`
+
+Pode-se obter o dataUnit através desse método. Outra forma, é ouvir o evento de
+
+#### Returns
+
+Type: `Promise<DataUnit>`
+
+dataUnit
+
+
+----------------------------------------------
+
+

package/components/snk-filter-bar/filter-item/editors/readme.md

@@ -0,0 +1,18 @@
+# snk-filter-text
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property | Attribute | Description | Type                  | Default     |
+| -------- | --------- | ----------- | --------------------- | ----------- |
+| `config` | --        |             | `SnkFilterItemConfig` | `undefined` |
+| `value`  | `value`   |             | `string`              | `undefined` |
+
+
+----------------------------------------------
+
+