@sankhyalabs/sankhyablocks-docs 9.1.0-dev.19 → 9.1.0-dev.20

package/components/snk-application/readme.md

@@ -9,12 +9,12 @@
 
 | Property                      | Attribute                         | Description                                                                                                                                                                                                                                 | Type                                                   | Default     |
 | ----------------------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | ----------- |
-| `configName`                  | `config-name`                     | Usado para salvar as configurações dos blocos de construção.                                                                                                                                                                                | `string`                                               | `undefined` |
-| `enableLockManagerLoadingApp` | `enable-lock-manager-loading-app` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação                                                                                                                                                   | `boolean`                                              | `undefined` |
-| `formLegacyConfigName`        | `form-legacy-config-name`         | Chave da configuração legado do formulário.                                                                                                                                                                                                 | `string`                                               | `undefined` |
-| `gridLegacyConfigName`        | `grid-legacy-config-name`         | Chave da configuração legado da grade.                                                                                                                                                                                                      | `string`                                               | `undefined` |
+| `configName`                  | `config-name`                     | Nome da configuração utilizada para salvar as preferências dos blocos de construção.                                                                                                                                                        | `string`                                               | `undefined` |
+| `enableLockManagerLoadingApp` | `enable-lock-manager-loading-app` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação.                                                                                                                                                  | `boolean`                                              | `undefined` |
+| `formLegacyConfigName`        | `form-legacy-config-name`         | Chave da configuração legada do formulário, utilizada para migração de configurações antigas.                                                                                                                                               | `string`                                               | `undefined` |
+| `gridLegacyConfigName`        | `grid-legacy-config-name`         | Chave da configuração legada da grade, utilizada para migração de configurações antigas.                                                                                                                                                    | `string`                                               | `undefined` |
 | `loadByPK`                    | --                                | Usado para receber um parâmetro na inicialização da tela, e utilizá-lo conforme necessário caso a tela receba um parâmetro, e, esta propriedade não seja informada é criado um filtro de forma automática através do método defaultLoadByPk | `(objPK: { pk: any; }, redirectFrom?: string) => void` | `undefined` |
-| `messagesBuilder`             | --                                |                                                                                                                                                                                                                                             | `SnkMessageBuilder`                                    | `undefined` |
+| `messagesBuilder`             | --                                | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.                                                                                                                                                      | `SnkMessageBuilder`                                    | `undefined` |
 
 
 ## Events
@@ -39,13 +39,13 @@ Type: `Promise<void>`
 
 ### `addLoadingLock(forceReady?: boolean, templateSkeletonType?: TEMPLATES_SKELETON) => Promise<() => void>`
 
-
+Adiciona um bloqueio de carregamento à aplicação.
 
 #### Returns
 
 Type: `Promise<() => void>`
 
-
+O ID do bloqueio adicionado.
 
 ### `addPendingAction(actionsLocker: string, action: Function) => Promise<void>`
 
@@ -59,13 +59,13 @@ Type: `Promise<void>`
 
 ### `addSearchListener(entityName: string, dataUnit: DataUnit, listener: ISearchListener) => Promise<IRemoveSearchListener>`
 
-Adiciona um listener no fetcher de Pesquisa
+Adiciona um listener no fetcher de Pesquisa.
 
 #### Returns
 
 Type: `Promise<IRemoveSearchListener>`
 
-
+Uma função para remover o listener.
 
 ### `alert(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
 
@@ -85,7 +85,7 @@ Realiza a chamada ao Service Broker conforme o nome do serviço.
 
 Type: `Promise<any>`
 
-
+A resposta do Service Broker.
 
 ### `clearPopUpTitle() => Promise<void>`
 
@@ -119,13 +119,13 @@ Type: `Promise<void>`
 
 ### `confirm(title: string, message: string, icon?: string, dialogType?: DialogType, options?: MessageOptions) => Promise<boolean>`
 
-Exibe um diálogo de confirmação
+Exibe um diálogo de confirmação.
 
 #### Returns
 
 Type: `Promise<boolean>`
 
-
+`true` se confirmado, `false` caso contrário.
 
 ### `createDataunit(entityName: string, dataUnitName?: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string) => Promise<DataUnit>`
 
@@ -136,7 +136,7 @@ passando o dataUnitName, assim, se mais de uma chamada for feita, o mesmo DataUn
 
 Type: `Promise<DataUnit>`
 
-
+O DataUnit criado ou obtido do cache.
 
 ### `error(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
 
@@ -150,14 +150,13 @@ 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[]>`
 
-
+Uma lista de opções ou uma única opção.
 
 ### `executePreparedSearchPlus(mode: string, argument: string, options: any) => Promise<Array<IOption> | IOption>`
 
@@ -170,16 +169,16 @@ Type: `Promise<IOption | IOption[]>`
 
 
 
-### `executeSearch(searchArgument: ISearchArgument, fieldName: string, dataUnit: DataUnit, ctxOptions?: any) => Promise<Array<IOption> | IOption>`
+### `executeSearch(searchArgument: ISearchArgument, fieldName: string, dataUnit: DataUnit, ctxOptions?: ISearchCtxOptions) => Promise<Array<IOption> | IOption>`
 
-Obtém as opções em componentes de pesquisa
+Obtém as opções em componentes de pesquisa.
 Ex.: snk-config-options
 
 #### Returns
 
 Type: `Promise<IOption | IOption[]>`
 
-
+Uma lista de opções ou uma única opção.
 
 ### `executeSelectDistinct(dataUnit: DataUnit, fieldName: string, argument: string) => Promise<Array<any>>`
 
@@ -191,27 +190,27 @@ coluna.
 
 Type: `Promise<any[]>`
 
-
+Uma lista de valores distintos.
 
 ### `getAllAccess(resourceID?: string) => Promise<any>`
 
-Obtém todos os acessos do usuário logado.
+Obtém todos os acessos do usuário logado para um recurso específico ou para a aplicação.
 
 #### Returns
 
 Type: `Promise<any>`
 
-
+Um objeto contendo todos os tipos de acesso e se o usuário os possui.
 
 ### `getAppLabel() => Promise<string>`
 
-Obtém o nome das telas da aplicação
+Obtém o nome (label) da aplicação.
 
 #### Returns
 
 Type: `Promise<string>`
 
-
+O nome da aplicação.
 
 ### `getApplicationPath() => Promise<string>`
 
@@ -221,7 +220,7 @@ Retorna o path relativo da aplicação.
 
 Type: `Promise<string>`
 
-
+O caminho relativo da aplicação.
 
 ### `getAttributeFromHTMLWrapper(attribName: string) => Promise<string>`
 
@@ -231,7 +230,7 @@ Acessa informações de contexto "empurrados" na abertura da tela.
 
 Type: `Promise<string>`
 
-
+O valor do atributo.
 
 ### `getBooleanParam(name: string) => Promise<boolean>`
 
@@ -241,37 +240,37 @@ Obtém o valor de um parâmetro do tipo booleano.
 
 Type: `Promise<boolean>`
 
-
+O valor do parâmetro como booleano.
 
 ### `getConfig(key: string) => Promise<any>`
 
-Obtém a configuração de um recurso por service broker
+Obtém a configuração de um recurso por service broker.
 
 #### Returns
 
 Type: `Promise<any>`
 
-
+Os dados da configuração.
 
 ### `getDataFetcher() => Promise<DataFetcher>`
 
-Retorna a instancia do DataFetcher utilizado pelo application
+Retorna a instância do DataFetcher utilizado pelo application.
 
 #### Returns
 
 Type: `Promise<DataFetcher>`
 
-DataFetcher do application
+O DataFetcher da aplicação.
 
 ### `getDataUnit(entityName: string, dataUnitName: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string) => Promise<DataUnit>`
 
-Obtem um DataUnit do cache ou cria um caso ainda não tenha sido criado.
+Obtém um DataUnit do cache ou cria um caso ainda não tenha sido criado.
 
 #### Returns
 
 Type: `Promise<DataUnit>`
 
-
+O DataUnit obtido do cache ou recém-criado.
 
 ### `getDateParam(name: string) => Promise<Date>`
 
@@ -281,7 +280,7 @@ Obtém o valor de um parâmetro do tipo data.
 
 Type: `Promise<Date>`
 
-
+O valor do parâmetro como objeto Date.
 
 ### `getFloatParam(name: string) => Promise<number>`
 
@@ -291,7 +290,7 @@ Obtém o valor de um parâmetro do tipo Decimal.
 
 Type: `Promise<number>`
 
-
+O valor do parâmetro como número decimal.
 
 ### `getIntParam(name: string) => Promise<number>`
 
@@ -301,7 +300,7 @@ Obtém o valor de um parâmetro do tipo Inteiro.
 
 Type: `Promise<number>`
 
-
+O valor do parâmetro como número inteiro.
 
 ### `getKeyboardManager() => Promise<KeyboardManager>`
 
@@ -311,17 +310,17 @@ Obtém o controlador de teclado.
 
 Type: `Promise<KeyboardManager>`
 
-the keyboard manager
+O gerenciador de teclado.
 
 ### `getLayoutFormConfig() => Promise<LayoutFormConfig>`
 
-Obtém o notificador de Layout de formulario.
+Obtém o notificador de Layout de formulário.
 
 #### Returns
 
 Type: `Promise<LayoutFormConfig>`
 
-the Configurador de Layout do Formulario
+O configurador de Layout do Formulário.
 
 ### `getResourceID() => Promise<string>`
 
@@ -331,7 +330,7 @@ Obtém o resourceID da tela em questão.
 
 Type: `Promise<string>`
 
-
+O ID do recurso da aplicação.
 
 ### `getStringParam(name: string) => Promise<string>`
 
@@ -341,41 +340,41 @@ Obtém o valor de um parâmetro do tipo string.
 
 Type: `Promise<string>`
 
-
+O valor do parâmetro como string.
 
 ### `getUserID() => Promise<string>`
 
-Obtém o UserId da tela em questão.
+Obtém o UserId do usuário logado.
 
 #### Returns
 
 Type: `Promise<string>`
 
-
+O ID do usuário.
 
 ### `hasAccess(access: AutorizationType, resourceID?: string) => Promise<boolean>`
 
-Obtém `true` caso o usuário logado tem permissão pra determinada ação.
+Obtém `true` caso o usuário logado tenha permissão para determinada ação.
 
 #### Returns
 
 Type: `Promise<boolean>`
 
-
+`true` se o usuário tiver acesso, `false` caso contrário.
 
 ### `hasClientEvent(eventID: String) => Promise<boolean>`
 
-Verfica se um client event está registrado no DataFetcher da aplicação.
+Verifica se um client event está registrado no DataFetcher da aplicação.
 
 #### Returns
 
 Type: `Promise<boolean>`
 
-
+`true` se o evento estiver registrado, `false` caso contrário.
 
 ### `importScript(relativePath: string | Array<string>) => Promise<void>`
 
-Realiza o import de um JavaScript que está disponivel dentro da pasta /public da aplicação.
+Realiza o import de um JavaScript que está disponível dentro da pasta /public da aplicação.
 
 #### Returns
 
@@ -395,7 +394,7 @@ Type: `Promise<void>`
 
 ### `initOnboarding(onboardingKey: string) => Promise<void>`
 
-
+Inicializa o onboarding para uma chave específica.
 
 #### Returns
 
@@ -425,13 +424,13 @@ Type: `Promise<boolean>`
 
 ### `isLoadedByPk() => Promise<boolean>`
 
-Obtém a informação se o último carregamento do dataunit foi feito através de um loadByPk
+Obtém a informação se o último carregamento do dataunit foi feito através de um loadByPk.
 
 #### Returns
 
 Type: `Promise<boolean>`
 
-boolean
+`true` se foi carregado por PK, `false` caso contrário.
 
 ### `isUserSup() => Promise<boolean>`
 
@@ -441,7 +440,7 @@ Obtém `true` caso o usuário logado seja o SUP.
 
 Type: `Promise<boolean>`
 
-
+`true` se o usuário for SUP, `false` caso contrário.
 
 ### `loadTotals(name: string, resourceID: string, filters: Array<Filter>) => Promise<Map<string, number>>`
 
@@ -451,11 +450,11 @@ Obtém os totalizadores da grade.
 
 Type: `Promise<Map<string, number>>`
 
-
+Um mapa com os nomes dos totalizadores e seus valores.
 
 ### `markToReload(templateSkeletonType?: TEMPLATES_SKELETON) => Promise<void>`
 
-
+Marca a aplicação para recarregar, opcionalmente especificando um tipo de esqueleto de carregamento.
 
 #### Returns
 
@@ -465,7 +464,7 @@ Type: `Promise<void>`
 
 ### `message(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
 
-Exibe um diálogo de mensagem comum
+Exibe um diálogo de mensagem comum.
 
 #### Returns
 
@@ -496,7 +495,7 @@ Type: `Promise<void>`
 
 ### `removeClientEvent(eventID: String) => Promise<void>`
 
-Remove um client event para o DataFetcher da aplicação.
+Remove um client event do DataFetcher da aplicação.
 
 #### Returns
 
@@ -512,7 +511,7 @@ Salva a configuração de determinado recurso.
 
 Type: `Promise<any>`
 
-
+O resultado da operação de salvamento.
 
 ### `setPopUpTitle(title: string) => Promise<void>`
 
@@ -536,9 +535,8 @@ Type: `Promise<void>`
 
 ### `showAlerts(alerts: Array<AlertItem>) => Promise<void>`
 
-Apresenta uma lista de alertas,
-geralmente é utilizado para apresentar resultados
-de processamentos em lote.
+Apresenta uma lista de alertas.
+Geralmente é utilizado para apresentar resultados de processamentos em lote.
 
 #### Returns
 
@@ -588,13 +586,13 @@ Type: `Promise<boolean>`
 
 ### `temOpcional(opcional: string) => Promise<boolean>`
 
-Verifica se a licença do cliente tem determinado opcional (produto)
+Verifica se a licença do cliente tem determinado opcional (produto).
 
 #### Returns
 
 Type: `Promise<boolean>`
 
-
+`true` se o cliente tiver o opcional, `false` caso contrário.
 
 ### `updateDataunitCache(oldName: string, dataUnitName: string, dataUnit: DataUnit) => Promise<void>`
 
@@ -618,13 +616,13 @@ Type: `Promise<void>`
 
 ### `whenApplicationReady() => Promise<SnkApplication>`
 
-Retorna uma promise que sera resolvida quando o snk-application estiver carregado e registrado no ApplicationContext
+Retorna uma promise que será resolvida quando o snk-application estiver carregado e registrado no ApplicationContext.
 
 #### Returns
 
 Type: `Promise<SnkApplication>`
 
-SnkApplication carregado.
+O componente SnkApplication carregado.
 
 
 ## Dependencies

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sankhyalabs/sankhyablocks-docs",
-    "version": "9.1.0-dev.19",
+    "version": "9.1.0-dev.20",
     "description": "Documentação da biblioteca de componentes Sankhya.",
     "main": "",
     "files": [