fluig-scaffolding-dataset
Gera o esqueleto de um Dataset customizado do Fluig — o arquivo JavaScript server-side com a(s) função(ões) nomeada(s) que a plataforma invoca para construir e retornar o conjunto de dados via API pública de Dataset, aplicando filtros/constraints e ordenação. Use quando o desenvolvedor pedir para criar/iniciar um novo dataset customizado a partir de um nome/propósito, campos e fontes de dados.
totvs · Static checks on file
Installation
Read the source and dependencies before running a command. Copying does not install or execute anything.
npx skills add totvs/fluig-agent-skills --skill fluig-scaffolding-datasetAbout this skill
name: fluig-scaffolding-dataset description: Gera o esqueleto de um Dataset customizado do Fluig — o arquivo JavaScript server-side com a(s) função(ões) nomeada(s) que a plataforma invoca para construir e retornar o conjunto de dados via API pública de Dataset, aplicando filtros/constraints e ordenação. Use quando o desenvolvedor pedir para criar/iniciar um novo dataset customizado a partir de um nome/propósito, campos e fontes de dados. argument-hint: 'nome e/ou propósito do dataset, campos e fontes/filtros (ex.: "dataset de filiais com código, nome e UF, filtrando ativas")'
Scaffolding de Dataset (customizado, server-side)
Esta skill gera o esqueleto de um Dataset customizado do Fluig; ela não duplica convenções — os arquivos de context/ são a fonte de verdade, referenciada abaixo.
Objetivo
Produzir, com responsabilidade única, o esqueleto de um Dataset customizado do Fluig: o arquivo JavaScript executado no servidor com a(s) função(ões) nomeada(s) que a plataforma invoca para construir e retornar o conjunto de dados, usando somente a API pública de Dataset, já com pontos para aplicar filtros/constraints e ordenação.
Quando Usar
- Ao criar um novo dataset customizado do Fluig a partir do zero, para expor/consultar dados a serem consumidos por widgets e forms.
- Quando o desenvolvedor fornece um nome/propósito, os campos do dataset e a(s) fonte(s) de dados e quer um ponto de partida correto (função pública + estrutura) seguindo as convenções oficiais.
- Quando é preciso garantir, desde o início, o uso exclusivo da API pública de Dataset e a aplicação correta de filtros (constraints) e ordenação.
Entradas Esperadas
| Entrada | Descrição | Obrigatória |
|---|---|---|
| Nome do dataset | Identificador do dataset customizado (ex.: branches) | sim |
| Campos | Lista de colunas/campos do dataset (nome de cada coluna) | sim |
| Filtros/constraints | Critérios de filtragem esperados (campo, valores, tipo) | não |
| Ordenação | Campo(s) por que o resultado deve ser ordenado | não |
| Fonte de dados | Origem dos registros (ex.: outro dataset, dados informados, serviço externo) | não |
| Serviço externo | Código do serviço cadastrado no Fluig (serviceCode) quando a fonte for uma API REST externa | não |
Contexto de Referência (Fonte de Verdade)
Leia antes de executar — não reproduza o conteúdo aqui:
- architecture.md — modelo conceitual do Dataset: customização server-side que expõe/consulta dados por meio da API pública de Dataset; o desenvolvedor implementa funções nomeadas que a plataforma invoca em pontos definidos para resolver o dataset; o resultado é consumido por widgets/forms. Veja também a seção "Estrutura de um Projeto Fluig Studio": o dataset fica na pasta
datasets/. - technologies.md — runtime público de scripting server-side: datasets são escritos em JavaScript executado no servidor sobre o motor Mozilla Rhino (base ES5, com suporte apenas parcial a ES6+), interagindo apenas com a API pública de seu contexto (sem acesso a componentes internos do servidor). Veja a seção "Runtime Rhino: sintaxe rígida (não é ES6+)" para as restrições de sintaxe e a seção de interoperabilidade com Java.
Regras Aplicáveis (Resumo Executivo)
Somente o mínimo para orientar a geração; o detalhe está no contexto:
- Implemente a(s) função(ões) nomeada(s) que a plataforma invoca para construir/retornar o dataset — o ponto de entrada público é a função
createDataset(fields, constraints, sortFields)→ verarchitecture.md. - Use SOMENTE a API pública de Dataset: construa o resultado com
DatasetBuilder.newDataset()e adicione colunas/linhas comaddColumn(...)/addRow(...); para consultar outro dataset, useDatasetFactory.getDataset(name, fields, constraints, order[, callback])(no servidor, sempre síncrono — não passecallback) → verarchitecture.md, seção "API pública de Dataset — assinaturas". - Retorne o conjunto de dados no formato esperado (o objeto de dataset construído pelo
DatasetBuilder); o retorno degetDataset(...)expõe os registros em.valuese as colunas em.columns→ verarchitecture.md. - Aplique filtros/constraints via API pública com a assinatura exata
DatasetFactory.createConstraint(field, initialValue, finalValue, type[, likeSearch]), ondetypeéConstraintType.MUST(1) |SHOULD(2) |MUST_NOT(3) elikeSearch(booleano opcional) habilita busca parcial (LIKE). Para igualdade simples, repita o valor eminitialValue/finalValue; para faixa (BETWEEN), informe limites distintos. Respeite os parâmetrosconstraintsesortFieldsrecebidos pela função → verarchitecture.md, seção "API pública de Dataset — assinaturas". - Leia os filtros recebidos percorrendo o array
constraintse comparandoconstraint.getFieldName()com o campo desejado, obtendo o valor comconstraint.getInitialValue()(use os métodos, não propriedades). Isolar isso em uma função auxiliar (ex.:obterParametro(constraints, campo)) é um padrão comum → verarchitecture.md. - Para consumir um serviço externo (REST), não há
fetch: use o Cadastro de Serviços viafluigAPI.getAuthorizeClientService(), montando o objeto comserviceCode/endpoint/method/timeoutService(ocompanyIdé opcional, resolvido a partir doserviceCode), invocando cominvoke(JSON.stringify(data))e lendo a resposta comvo.getResult()+JSON.parse(...)→ vertechnologies.md. - Trate erros retornando dado, não exceção solta: capture o erro com
try/catche retorne um dataset com uma coluna/linha de erro (ex.: colunaERROR), para o consumidor receber um resultado previsível → verarchitecture.md. - Código server-side no motor Rhino (base ES5, não ES6+): use
varefunctiontradicionais, concatene strings com+e evite arrow functions,