@sankhyalabs/sankhyablocks-docs 0.0.0-feat-dev-kb-4158.0

package/components/snk-actions-button/readme.md

@@ -0,0 +1,33 @@
+# snk-actions-button
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Dependencies
+
+### Used by
+
+ - [snk-crud](../snk-crud)
+ - [snk-detail-view](../snk-crud/subcomponents/snk-detail-view)
+ - [snk-grid](../snk-grid)
+ - [snk-guides-viewer](../snk-crud/subcomponents)
+ - [snk-simple-crud](../snk-simple-crud)
+ - [snk-taskbar](../snk-taskbar)
+
+### Graph
+```mermaid
+graph TD;
+  snk-crud --> snk-actions-button
+  snk-detail-view --> snk-actions-button
+  snk-grid --> snk-actions-button
+  snk-guides-viewer --> snk-actions-button
+  snk-simple-crud --> snk-actions-button
+  snk-taskbar --> snk-actions-button
+  style snk-actions-button fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/snk-actions-button/subcomponents/readme.md

@@ -0,0 +1,33 @@
+# snk-client-confirm
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property       | Attribute       | Description                       | Type         | Default     |
+| -------------- | --------------- | --------------------------------- | ------------ | ----------- |
+| `accept`       | --              | Retorno quando usuário confirmar. | `() => void` | `undefined` |
+| `cancel`       | --              | Retorno quando usuário cancelar.  | `() => void` | `undefined` |
+| `message`      | `message`       | Mensagem da popup.                | `string`     | `undefined` |
+| `titleMessage` | `title-message` | Título da popup.                  | `string`     | `undefined` |
+
+
+## Methods
+
+### `openPopup() => Promise<void>`
+
+Responsável por abrir a popup.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+----------------------------------------------
+
+

package/components/snk-application/readme.md

@@ -0,0 +1,502 @@
+# 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` | --            |                                                              | `SnkMessageBuilder` | `undefined` |
+
+
+## Events
+
+| Event                | Description                               | Type                   |
+| -------------------- | ----------------------------------------- | ---------------------- |
+| `applicationLoaded`  | Emitido quando a aplicação for carregada. | `CustomEvent<boolean>` |
+| `applicationLoading` | Emitido ao iniciar a carga do componente. | `CustomEvent<boolean>` |
+
+
+## Methods
+
+### `addClientEvent(eventID: String, handler: (clientEvent: IClientEventResponse, dataFetcherReacaller: IDataFetcherRecaller) => void) => Promise<void>`
+
+Registra um client event para o DataFetcher da aplicação.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `addSearchListener(entityName: string, dataUnit: DataUnit, listener: ISearchListener) => Promise<IRemoveSearchListener>`
+
+Adiciona um listener no fetcher de Pesquisa
+
+#### Returns
+
+Type: `Promise<IRemoveSearchListener>`
+
+
+
+### `alert(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
+
+Exibe o diálogo de alerta de acordo com os parâmetros passados.
+
+#### Returns
+
+Type: `Promise<boolean>`
+
+
+
+### `callServiceBroker(serviceName: string, payload: string | Object, options?: Options) => Promise<any>`
+
+Realiza a chamada ao Service Broker conforme o nome do serviço.
+
+#### Returns
+
+Type: `Promise<any>`
+
+
+
+### `closeModal() => Promise<void>`
+
+Fecha o Modal e limpa o conteúdo.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `closePopUp() => Promise<void>`
+
+Fecha o Popup e limpa 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, parentDataUnit?: DataUnit, configName?: 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>`
+
+Exibe 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>`
+
+Obtém as opções em componentes de pesquisa
+Ex.: snk-config-options
+
+#### Returns
+
+Type: `Promise<IOption | IOption[]>`
+
+
+
+### `executeSearch(searchArgument: ISearchArgument, fieldName: string, dataUnit: DataUnit) => Promise<Array<IOption> | IOption>`
+
+Obtém as opções em componentes de pesquisa
+Ex.: snk-config-options
+
+#### Returns
+
+Type: `Promise<IOption | IOption[]>`
+
+
+
+### `executeSelectDistinct(dataUnit: DataUnit, fieldName: string, argument: string) => Promise<Array<any>>`
+
+Com base em um campo realiza um "select distinct" respeitando os 
+filtros atuais do dataUnit e um critério de filtro para a própria 
+coluna.
+
+#### Returns
+
+Type: `Promise<any[]>`
+
+
+
+### `getAllAccess() => Promise<any>`
+
+Obtém todos os acessos do usuário logado.
+
+#### Returns
+
+Type: `Promise<any>`
+
+
+
+### `getAppLabel() => Promise<string>`
+
+Obtém o nome das telas da aplicação
+
+#### Returns
+
+Type: `Promise<string>`
+
+
+
+### `getApplicationPath() => Promise<string>`
+
+Retorna o path relativo da aplicação.
+
+#### Returns
+
+Type: `Promise<string>`
+
+
+
+### `getAttributeFromHTMLWrapper(attribName: string) => Promise<string>`
+
+Acessa informações de contexto "empurrados" na abertura da tela.
+
+#### Returns
+
+Type: `Promise<string>`
+
+
+
+### `getBooleanParam(name: string) => Promise<boolean>`
+
+Obtém o valor de um parâmetro do tipo booleano.
+
+#### Returns
+
+Type: `Promise<boolean>`
+
+
+
+### `getConfig(key: string) => Promise<any>`
+
+Obtém a configuração de um recurso por service broker
+
+#### Returns
+
+Type: `Promise<any>`
+
+
+
+### `getDataFetcher() => Promise<DataFetcher>`
+
+Retorna a instancia do DataFetcher utilizado pelo application
+
+#### Returns
+
+Type: `Promise<DataFetcher>`
+
+DataFetcher do application
+
+### `getDataUnit(entityName: string, dataUnitName: string, parentDataUnit?: DataUnit, configName?: 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>`
+
+Obtém o valor de um parâmetro do tipo data.
+
+#### Returns
+
+Type: `Promise<Date>`
+
+
+
+### `getFloatParam(name: string) => Promise<number>`
+
+Obtém o valor de um parâmetro do tipo Decimal.
+
+#### Returns
+
+Type: `Promise<number>`
+
+
+
+### `getIntParam(name: string) => Promise<number>`
+
+Obtém o valor de um parâmetro do tipo Inteiro.
+
+#### Returns
+
+Type: `Promise<number>`
+
+
+
+### `getResourceID() => Promise<string>`
+
+Obtém o resourceID da tela em questão.
+
+#### Returns
+
+Type: `Promise<string>`
+
+
+
+### `getStringParam(name: string) => Promise<string>`
+
+Obtém o valor de um parâmetro do tipo string.
+
+#### Returns
+
+Type: `Promise<string>`
+
+
+
+### `getUserID() => Promise<string>`
+
+Obtém o UserId da tela em questão.
+
+#### Returns
+
+Type: `Promise<string>`
+
+
+
+### `hasAccess(access: AutorizationType) => Promise<boolean>`
+
+Obtém `true` caso o usuário logado tem permissão pra determinada ação.
+
+#### Returns
+
+Type: `Promise<boolean>`
+
+
+
+### `hasClientEvent(eventID: String) => Promise<boolean>`
+
+Verfica se um client event está registrado no DataFetcher da aplicação.
+
+#### Returns
+
+Type: `Promise<boolean>`
+
+
+
+### `importScript(relativePath: string | Array<string>) => Promise<void>`
+
+Realiza o import de um JavaScript que está disponivel dentro da pasta /public da aplicação.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `info(message: string, options?: MessageOptions) => Promise<void>`
+
+Exibe uma informação efêmera (de segundo plano).
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `initOnboarding(onboardingKey: string) => Promise<void>`
+
+
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `isDebugMode() => Promise<boolean>`
+
+Obtém `true` caso a tela esteja em modo de debug.
+
+#### Returns
+
+Type: `Promise<boolean>`
+
+
+
+### `isUserSup() => Promise<boolean>`
+
+Obtém `true` caso o usuário logado seja o SUP.
+
+#### Returns
+
+Type: `Promise<boolean>`
+
+
+
+### `loadGridConfig(name: string) => Promise<IGridConfig>`
+
+Obtém a configuração de grade.
+
+#### Returns
+
+Type: `Promise<IGridConfig>`
+
+
+
+### `loadTotals(name: string, resourceID: string, filters: Array<Filter>) => Promise<Map<string, number>>`
+
+Obtém 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>`
+
+
+
+### `removeClientEvent(eventID: String) => Promise<void>`
+
+Remove um client event para o DataFetcher da aplicação.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `saveConfig(key: string, data: Object) => Promise<any>`
+
+Salva a configuração de determinado recurso.
+
+#### Returns
+
+Type: `Promise<any>`
+
+
+
+### `showModal(content: HTMLElement) => Promise<void>`
+
+Exibe o conteúdo passado em um Modal.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `showPopUp(content: HTMLElement, size?: "auto" | "full", useHeader?: boolean) => Promise<void>`
+
+Exibe o conteúdo passado em um Popup.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `success(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
+
+Exibe 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>`
+
+
+
+### `updateDataunitCache(oldName: string, dataUnitName: string, dataUnit: DataUnit) => Promise<void>`
+
+Atualiza o cache de dataunits da aplicação.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `webConnection(keyPort: string, methodName: string, params: IAppletCallerParams) => Promise<void>`
+
+Realiza a chamada do WebConnection para realizar a exportação de arquivo.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+## 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-attach/readme.md

@@ -0,0 +1,55 @@
+# snk-attach
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property                   | Attribute      | Description                                                                            | Type                | Default     |
+| -------------------------- | -------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
+| `entityName` _(required)_  | `entity-name`  | Nome da entidade à ser utilizada para relacionar o anexo ao DataUnit pai.              | `string`            | `undefined` |
+| `messagesBuilder`          | --             | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
+| `registerKey` _(required)_ | `register-key` | Identificação do registro pai.                                                         | `string`            | `undefined` |
+
+
+## Events
+
+| Event  | Description                                              | Type                |
+| ------ | -------------------------------------------------------- | ------------------- |
+| `back` | Evento disparado quando o usuário clica no botão voltar. | `CustomEvent<void>` |
+
+
+## Dependencies
+
+### Used by
+
+ - [snk-crud](../snk-crud)
+ - [snk-detail-view](../snk-crud/subcomponents/snk-detail-view)
+
+### Depends on
+
+- [snk-simple-bar](../snk-simple-bar)
+- [snk-simple-crud](../snk-simple-crud)
+
+### Graph
+```mermaid
+graph TD;
+  snk-attach --> snk-simple-bar
+  snk-attach --> snk-simple-crud
+  snk-simple-crud --> snk-data-unit
+  snk-simple-crud --> snk-taskbar
+  snk-simple-crud --> snk-data-exporter
+  snk-simple-crud --> snk-actions-button
+  snk-taskbar --> snk-data-exporter
+  snk-taskbar --> snk-actions-button
+  snk-data-exporter --> snk-exporter-email-sender
+  snk-crud --> snk-attach
+  snk-detail-view --> snk-attach
+  style snk-attach fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/snk-configurator/readme.md

@@ -0,0 +1,68 @@
+# snk-configurator
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property            | Attribute             | Description                                                                            | Type                                                       | Default          |
+| ------------------- | --------------------- | -------------------------------------------------------------------------------------- | ---------------------------------------------------------- | ---------------- |
+| `configName`        | `config-name`         | Usado para guardar ou recuperar as configurações do formulário.                        | `string`                                                   | `undefined`      |
+| `messagesBuilder`   | --                    | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder`                                        | `undefined`      |
+| `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação                                                    | `boolean`                                                  | `false`          |
+| `viewMode`          | `view-mode`           | Define qual modo de visualização está ativo.                                           | `VIEW_MODE.ATTACHMENT \| VIEW_MODE.FORM \| VIEW_MODE.GRID` | `VIEW_MODE.GRID` |
+
+
+## Events
+
+| Event            | Description                                          | Type                                                                    |
+| ---------------- | ---------------------------------------------------- | ----------------------------------------------------------------------- |
+| `cancel`         | Emitido quando cancela o salvamento da configuração. | `CustomEvent<void>`                                                     |
+| `configSelected` | Emitido quando seleciona o modo de visualização.     | `CustomEvent<VIEW_MODE.ATTACHMENT \| VIEW_MODE.FORM \| VIEW_MODE.GRID>` |
+| `openConfig`     | Emitido quando clica para abrir a configuração.      | `CustomEvent<VIEW_MODE.ATTACHMENT \| VIEW_MODE.FORM \| VIEW_MODE.GRID>` |
+| `save`           | Emitido quando salva a configuração.                 | `CustomEvent<void>`                                                     |
+
+
+## Methods
+
+### `close() => Promise<void>`
+
+Fecha a janela de configuração.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `open() => Promise<void>`
+
+Exibe a janela de configuração.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+## Dependencies
+
+### Used by
+
+ - [snk-crud](../snk-crud)
+ - [snk-guides-viewer](../snk-crud/subcomponents)
+
+### Graph
+```mermaid
+graph TD;
+  snk-crud --> snk-configurator
+  snk-guides-viewer --> snk-configurator
+  style snk-configurator fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+