@sankhyalabs/sankhyablocks-docs 9.1.13 → 9.2.0-dev.1

package/components/snk-application/readme.md

@@ -35,7 +35,7 @@ Registra um client event para o DataFetcher da aplicação.
 
 Type: `Promise<void>`
 
----
+
 
 ### `addLoadingLock(forceReady?: boolean, templateSkeletonType?: TEMPLATES_SKELETON) => Promise<() => void>`
 
@@ -47,8 +47,6 @@ Type: `Promise<() => void>`
 
 O ID do bloqueio adicionado.
 
----
-
 ### `addPendingAction(actionsLocker: string, action: Function) => Promise<void>`
 
 Adiciona uma ação pendente que deve ser executada por um determinado locker.
@@ -57,7 +55,7 @@ Adiciona uma ação pendente que deve ser executada por um determinado locker.
 
 Type: `Promise<void>`
 
----
+
 
 ### `addSearchListener(entityName: string, dataUnit: DataUnit, listener: ISearchListener) => Promise<IRemoveSearchListener>`
 
@@ -69,8 +67,6 @@ Type: `Promise<IRemoveSearchListener>`
 
 Uma função para remover o listener.
 
----
-
 ### `alert(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
 
 Exibe o diálogo de alerta de acordo com os parâmetros passados.
@@ -79,7 +75,7 @@ Exibe o diálogo de alerta de acordo com os parâmetros passados.
 
 Type: `Promise<boolean>`
 
----
+
 
 ### `callServiceBroker(serviceName: string, payload: string | Object, options?: Options) => Promise<any>`
 
@@ -91,8 +87,6 @@ Type: `Promise<any>`
 
 A resposta do Service Broker.
 
----
-
 ### `clearPopUpTitle() => Promise<void>`
 
 
@@ -101,7 +95,7 @@ A resposta do Service Broker.
 
 Type: `Promise<void>`
 
----
+
 
 ### `closeModal() => Promise<void>`
 
@@ -111,7 +105,7 @@ Fecha o Modal e limpa o conteúdo.
 
 Type: `Promise<void>`
 
----
+
 
 ### `closePopUp() => Promise<void>`
 
@@ -121,7 +115,7 @@ Fecha o Popup e limpa o conteúdo.
 
 Type: `Promise<void>`
 
----
+
 
 ### `confirm(title: string, message: string, icon?: string, dialogType?: DialogType, options?: MessageOptions) => Promise<boolean>`
 
@@ -133,8 +127,6 @@ Type: `Promise<boolean>`
 
 `true` se confirmado, `false` caso contrário.
 
----
-
 ### `createDataunit(entityName: string, dataUnitName?: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string) => Promise<DataUnit>`
 
 Cria o DataUnit a partir do nome da entidade. É possível armazená-lo no cache
@@ -146,8 +138,6 @@ Type: `Promise<DataUnit>`
 
 O DataUnit criado ou obtido do cache.
 
----
-
 ### `error(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
 
 Exibe o diálogo de erro de acordo com os parâmetros passados.
@@ -156,9 +146,9 @@ Exibe o diálogo de erro de acordo com os parâmetros passados.
 
 Type: `Promise<boolean>`
 
----
 
-### `executePreparedSearch(mode: string, argument: string, options: any) => Promise<Array<IOption> | IOption>`
+
+### `executePreparedSearch(mode: string, argument: string, options: IPreparedSearchOptions) => Promise<Array<IOption> | IOption>`
 
 Obtém as opções em componentes de pesquisa com base em opções preparadas.
 Ex.: snk-config-options
@@ -169,9 +159,7 @@ 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>`
+### `executePreparedSearchPlus(mode: string, argument: string, options: IPreparedSearchOptions) => Promise<Array<IOption> | IOption>`
 
 Realiza a pesquisa de registros
 Ex.: snk-config-options
@@ -180,9 +168,7 @@ Ex.: snk-config-options
 
 Type: `Promise<IOption | IOption[]>`
 
-Uma lista de opções ou uma única opção.
 
----
 
 ### `executeSearch(searchArgument: ISearchArgument, fieldName: string, dataUnit: DataUnit, ctxOptions?: ISearchCtxOptions) => Promise<Array<IOption> | IOption>`
 
@@ -195,8 +181,6 @@ Type: `Promise<IOption | IOption[]>`
 
 Uma lista de opções ou uma única opção.
 
----
-
 ### `executeSelectDistinct(dataUnit: DataUnit, fieldName: string, argument: string) => Promise<Array<any>>`
 
 Com base em um campo realiza um "select distinct" respeitando os
@@ -209,8 +193,6 @@ Type: `Promise<any[]>`
 
 Uma lista de valores distintos.
 
----
-
 ### `getAllAccess(resourceID?: string) => Promise<any>`
 
 Obtém todos os acessos do usuário logado para um recurso específico ou para a aplicação.
@@ -221,8 +203,6 @@ 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 (label) da aplicação.
@@ -233,8 +213,6 @@ Type: `Promise<string>`
 
 O nome da aplicação.
 
----
-
 ### `getApplicationPath() => Promise<string>`
 
 Retorna o path relativo da aplicação.
@@ -245,8 +223,6 @@ Type: `Promise<string>`
 
 O caminho relativo da aplicação.
 
----
-
 ### `getAttributeFromHTMLWrapper(attribName: string) => Promise<string>`
 
 Acessa informações de contexto "empurrados" na abertura da tela.
@@ -257,8 +233,6 @@ Type: `Promise<string>`
 
 O valor do atributo.
 
----
-
 ### `getBooleanParam(name: string) => Promise<boolean>`
 
 Obtém o valor de um parâmetro do tipo booleano.
@@ -269,8 +243,6 @@ 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.
@@ -281,8 +253,6 @@ Type: `Promise<any>`
 
 Os dados da configuração.
 
----
-
 ### `getDataFetcher() => Promise<DataFetcher>`
 
 Retorna a instância do DataFetcher utilizado pelo application.
@@ -293,8 +263,6 @@ Type: `Promise<DataFetcher>`
 
 O DataFetcher da aplicação.
 
----
-
 ### `getDataUnit(entityName: string, dataUnitName: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string) => Promise<DataUnit>`
 
 Obtém um DataUnit do cache ou cria um caso ainda não tenha sido criado.
@@ -305,8 +273,6 @@ Type: `Promise<DataUnit>`
 
 O DataUnit obtido do cache ou recém-criado.
 
----
-
 ### `getDateParam(name: string) => Promise<Date>`
 
 Obtém o valor de um parâmetro do tipo data.
@@ -317,8 +283,6 @@ Type: `Promise<Date>`
 
 O valor do parâmetro como objeto Date.
 
----
-
 ### `getFloatParam(name: string) => Promise<number>`
 
 Obtém o valor de um parâmetro do tipo Decimal.
@@ -329,8 +293,6 @@ Type: `Promise<number>`
 
 O valor do parâmetro como número decimal.
 
----
-
 ### `getIntParam(name: string) => Promise<number>`
 
 Obtém o valor de um parâmetro do tipo Inteiro.
@@ -341,8 +303,6 @@ Type: `Promise<number>`
 
 O valor do parâmetro como número inteiro.
 
----
-
 ### `getKeyboardManager() => Promise<KeyboardManager>`
 
 Obtém o controlador de teclado.
@@ -353,8 +313,6 @@ Type: `Promise<KeyboardManager>`
 
 O gerenciador de teclado.
 
----
-
 ### `getLayoutFormConfig() => Promise<LayoutFormConfig>`
 
 Obtém o notificador de Layout de formulário.
@@ -365,8 +323,6 @@ Type: `Promise<LayoutFormConfig>`
 
 O configurador de Layout do Formulário.
 
----
-
 ### `getResourceID() => Promise<string>`
 
 Obtém o resourceID da tela em questão.
@@ -377,8 +333,6 @@ Type: `Promise<string>`
 
 O ID do recurso da aplicação.
 
----
-
 ### `getStringParam(name: string) => Promise<string>`
 
 Obtém o valor de um parâmetro do tipo string.
@@ -389,8 +343,6 @@ Type: `Promise<string>`
 
 O valor do parâmetro como string.
 
----
-
 ### `getUserID() => Promise<string>`
 
 Obtém o UserId do usuário logado.
@@ -401,8 +353,6 @@ Type: `Promise<string>`
 
 O ID do usuário.
 
----
-
 ### `hasAccess(access: AutorizationType, resourceID?: string) => Promise<boolean>`
 
 Obtém `true` caso o usuário logado tenha permissão para determinada ação.
@@ -413,8 +363,6 @@ Type: `Promise<boolean>`
 
 `true` se o usuário tiver acesso, `false` caso contrário.
 
----
-
 ### `hasClientEvent(eventID: String) => Promise<boolean>`
 
 Verifica se um client event está registrado no DataFetcher da aplicação.
@@ -425,8 +373,6 @@ 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á disponível dentro da pasta /public da aplicação.
@@ -435,7 +381,7 @@ Realiza o import de um JavaScript que está disponível dentro da pasta /public
 
 Type: `Promise<void>`
 
----
+
 
 ### `info(message: string, options?: MessageOptions) => Promise<void>`
 
@@ -445,7 +391,7 @@ Exibe uma informação efêmera (de segundo plano).
 
 Type: `Promise<void>`
 
----
+
 
 ### `initOnboarding(onboardingKey: string) => Promise<void>`
 
@@ -455,7 +401,7 @@ Inicializa o onboarding para uma chave específica.
 
 Type: `Promise<void>`
 
----
+
 
 ### `isDebugMode() => Promise<boolean>`
 
@@ -465,7 +411,17 @@ Obtém `true` caso a tela esteja em modo de debug.
 
 Type: `Promise<boolean>`
 
----
+
+
+### `isFeatureActive(featureName: string) => Promise<boolean>`
+
+Retorna se uma feature flag global está ativa ou não.
+
+#### Returns
+
+Type: `Promise<boolean>`
+
+
 
 ### `isLoadedByPk() => Promise<boolean>`
 
@@ -477,8 +433,6 @@ Type: `Promise<boolean>`
 
 `true` se foi carregado por PK, `false` caso contrário.
 
----
-
 ### `isUserSup() => Promise<boolean>`
 
 Obtém `true` caso o usuário logado seja o SUP.
@@ -489,8 +443,6 @@ 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>>`
 
 Obtém os totalizadores da grade.
@@ -501,8 +453,6 @@ 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.
@@ -511,7 +461,7 @@ Marca a aplicação para recarregar, opcionalmente especificando um tipo de esqu
 
 Type: `Promise<void>`
 
----
+
 
 ### `message(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
 
@@ -521,7 +471,7 @@ Exibe um diálogo de mensagem comum.
 
 Type: `Promise<boolean>`
 
----
+
 
 ### `openApp(resourceId: string, pkObject: Object) => Promise<void>`
 
@@ -531,7 +481,7 @@ Abre determinada tela, repassando pkObject.
 
 Type: `Promise<void>`
 
----
+
 
 ### `preloadMangerRemoveRecord(dataUnit: DataUnit, recordsIDs: Array<string>) => Promise<void>`
 
@@ -542,7 +492,7 @@ Deve ser usado quando existe um dataunit usando loader do application, mas o rem
 
 Type: `Promise<void>`
 
----
+
 
 ### `removeClientEvent(eventID: String) => Promise<void>`
 
@@ -552,7 +502,7 @@ Remove um client event do DataFetcher da aplicação.
 
 Type: `Promise<void>`
 
----
+
 
 ### `saveConfig(key: string, data: Object) => Promise<any>`
 
@@ -564,8 +514,6 @@ Type: `Promise<any>`
 
 O resultado da operação de salvamento.
 
----
-
 ### `setPopUpTitle(title: string) => Promise<void>`
 
 
@@ -574,7 +522,7 @@ O resultado da operação de salvamento.
 
 Type: `Promise<void>`
 
----
+
 
 ### `setSearchFilterContext(name: string, value: string) => Promise<void>`
 
@@ -584,7 +532,7 @@ Atribui valor para parâmetros de contexto no componente de pesquisa.
 
 Type: `Promise<void>`
 
----
+
 
 ### `showAlerts(alerts: Array<AlertItem>) => Promise<void>`
 
@@ -595,7 +543,7 @@ Geralmente é utilizado para apresentar resultados de processamentos em lote.
 
 Type: `Promise<void>`
 
----
+
 
 ### `showModal(content: HTMLElement) => Promise<void>`
 
@@ -605,7 +553,7 @@ Exibe o conteúdo passado em um Modal.
 
 Type: `Promise<void>`
 
----
+
 
 ### `showPopUp(content: HTMLElement, size?: "auto" | "full", useHeader?: boolean, onCloseCallback?: Function) => Promise<void>`
 
@@ -615,7 +563,7 @@ Exibe o conteúdo passado em um Popup.
 
 Type: `Promise<void>`
 
----
+
 
 ### `showScrimApp(active: boolean) => Promise<void>`
 
@@ -625,7 +573,7 @@ Type: `Promise<void>`
 
 Type: `Promise<void>`
 
----
+
 
 ### `success(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
 
@@ -635,7 +583,7 @@ Exibe o diálogo de sucesso de acordo com os parâmetros passados.
 
 Type: `Promise<boolean>`
 
----
+
 
 ### `temOpcional(opcional: string) => Promise<boolean>`
 
@@ -647,8 +595,6 @@ Type: `Promise<boolean>`
 
 `true` se o cliente tiver o opcional, `false` caso contrário.
 
----
-
 ### `updateDataunitCache(oldName: string, dataUnitName: string, dataUnit: DataUnit) => Promise<void>`
 
 Atualiza o cache de dataunits da aplicação.
@@ -657,7 +603,7 @@ Atualiza o cache de dataunits da aplicação.
 
 Type: `Promise<void>`
 
----
+
 
 ### `webConnection(keyPort: string, methodName: string, params: IAppletCallerParams) => Promise<void>`
 
@@ -667,7 +613,7 @@ Realiza a chamada do WebConnection para realizar a exportação de arquivo.
 
 Type: `Promise<void>`
 
----
+
 
 ### `whenApplicationReady() => Promise<SnkApplication>`
 

package/components/snk-attach/readme.md

@@ -7,15 +7,16 @@
 
 ## Properties
 
-| Property                   | Attribute      | Description                                                                            | Type                                      | Default     |
-| -------------------------- | -------------- | -------------------------------------------------------------------------------------- | ----------------------------------------- | ----------- |
-| `dataUnit`                 | --             | DataUnit responsável por carregar os dados.                                            | `DataUnit`                                | `undefined` |
-| `dataUnitBuilder`          | --             | DataUnitBuilder responsável por implementar dados a serem utilizados no DataUnit.      | `FetcherFacade`                           | `undefined` |
-| `entityName`               | `entity-name`  | Nome da entidade à ser utilizada para relacionar o anexo ao DataUnit pai.              | `string`                                  | `undefined` |
-| `fetcher`                  | --             | Fetcher responsável por carregar os dados do DataUnit.                                 | `AttachFetcherFacadeInterface`            | `undefined` |
-| `fetcherType`              | `fetcher-type` | FetcherType define o tipo de fetcher responsável por carregar os dados do DataUnit.    | `"AnexoSistema" \| "Another" \| "Attach"` | `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` |
+| Property                   | Attribute                 | Description                                                                            | Type                                      | Default     |
+| -------------------------- | ------------------------- | -------------------------------------------------------------------------------------- | ----------------------------------------- | ----------- |
+| `dataUnit`                 | --                        | DataUnit responsável por carregar os dados.                                            | `DataUnit`                                | `undefined` |
+| `dataUnitBuilder`          | --                        | DataUnitBuilder responsável por implementar dados a serem utilizados no DataUnit.      | `FetcherFacade`                           | `undefined` |
+| `entityName`               | `entity-name`             | Nome da entidade à ser utilizada para relacionar o anexo ao DataUnit pai.              | `string`                                  | `undefined` |
+| `fetcher`                  | --                        | Fetcher responsável por carregar os dados do DataUnit.                                 | `AttachFetcherFacadeInterface`            | `undefined` |
+| `fetcherType`              | `fetcher-type`            | FetcherType define o tipo de fetcher responsável por carregar os dados do DataUnit.    | `"AnexoSistema" \| "Another" \| "Attach"` | `undefined` |
+| `gridLegacyConfigName`     | `grid-legacy-config-name` | Chave da configuração legado da grid.                                                  | `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

package/components/snk-configurator/readme.md

@@ -38,7 +38,7 @@ Fecha a janela de configuração.
 
 Type: `Promise<void>`
 
----
+
 
 ### `open() => Promise<void>`
 

package/components/snk-crud/readme.md

@@ -60,7 +60,7 @@ Registra um editor customizado para campos da grade e formulário.
 
 Type: `Promise<void>`
 
----
+
 
 ### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
 
@@ -70,7 +70,7 @@ Registra um formatador de valores para uma coluna da grid.
 
 Type: `Promise<void>`
 
----
+
 
 ### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
 
@@ -80,7 +80,7 @@ Registra um render customizado para colunas da grid.
 
 Type: `Promise<void>`
 
----
+
 
 ### `closeConfigurator() => Promise<void>`
 
@@ -90,7 +90,7 @@ Usado para fechar o configurator do CRUD
 
 Type: `Promise<void>`
 
----
+
 
 ### `getFilterBar() => Promise<HTMLSnkFilterBarElement>`
 
@@ -100,7 +100,7 @@ Retorna o elemento da filter-bar da grade.
 
 Type: `Promise<HTMLSnkFilterBarElement>`
 
----
+
 
 ### `goToView(mode: string) => Promise<void>`
 
@@ -110,7 +110,7 @@ Usado para alternar a visão entre GRID e FORM externamente.
 
 Type: `Promise<void>`
 
----
+
 
 ### `openConfigurator() => Promise<void>`
 
@@ -120,7 +120,7 @@ Usado para abrir o configurator do CRUD
 
 Type: `Promise<void>`
 
----
+
 
 ### `reloadFilterBar() => Promise<void>`
 
@@ -130,7 +130,7 @@ Faz o recarregamento da filter-bar do crud, buscando o state no servidor.
 
 Type: `Promise<void>`
 
----
+
 
 ### `removeCustomValueFormatter(columnName: string) => Promise<void>`
 
@@ -140,7 +140,7 @@ Remove o formatador de valores de uma coluna da grid.
 
 Type: `Promise<void>`
 
----
+
 
 ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
 

package/components/snk-crud/subcomponents/readme.md

@@ -49,7 +49,7 @@ Registra um editor customizado para campos da grade e formulário
 
 Type: `Promise<void>`
 
----
+
 
 ### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
 
@@ -59,7 +59,7 @@ Registra um render customizado para colunas da grid.
 
 Type: `Promise<void>`
 
----
+
 
 ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
 
@@ -69,7 +69,7 @@ Altera/adiciona uma propriedade nos metadados do campo.
 
 Type: `Promise<void>`
 
----
+
 
 ### `setFocus() => Promise<void>`
 
@@ -79,7 +79,7 @@ Atribui o foco para o componente.
 
 Type: `Promise<void>`
 
----
+
 
 ### `showFormConfig(detail?: boolean) => Promise<void>`
 

package/components/snk-crud/subcomponents/snk-detail-view/readme.md

@@ -46,7 +46,7 @@ Registra um editor customizado para campos da grade e formulário.
 
 Type: `Promise<void>`
 
----
+
 
 ### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
 
@@ -56,7 +56,7 @@ Registra um render customizado para colunas da grid.
 
 Type: `Promise<void>`
 
----
+
 
 ### `changeViewMode(mode: VIEW_MODE) => Promise<void>`
 
@@ -66,7 +66,7 @@ Muda o modo de visualização do componente entre VIEW_MODE.GRID e VIEW_MODE.FOR
 
 Type: `Promise<void>`
 
----
+
 
 ### `configGrid() => Promise<void>`
 
@@ -76,7 +76,7 @@ Abre o configurador de grid.
 
 Type: `Promise<void>`
 
----
+
 
 ### `showUp() => Promise<void>`
 

package/components/snk-data-exporter/exporter-email-sender/readme.md

@@ -22,7 +22,7 @@
 
 Type: `Promise<IExportResult>`
 
----
+
 
 ### `open(config: IExportConfig) => Promise<IExportResult>`