Tornar funções TypeScript persistentes e retentáveis com o Workflow SDK

Install

npm install workflow

Para quem

Este skill serve para quem quer escrever funções «persistentes» em TypeScript ou JavaScript: o texto oficial diz que ele guarda o progresso do workflow, retenta passos com falha e oferece observabilidade embutida. Também serve para quem já usa Next.js e pretende ligar o invólucro oficial na configuração.

Não serve para quem só quer iniciar um workflow direto no navegador. O texto-fonte limita o local de início a rotas API, Server Action ou outro código de servidor. Se você ainda não consegue executar npm, ou não aceita uma instalação local de pacote, pare na leitura do guia.

Depois de instalar o pacote, um agente de código pode ler guias alinhados à versão atual em node_modules/workflow/docs. O repositório oficial é

https://github.com/vercel/workflow

Siga os comandos já escritos nessa página.

Primeira tentativa em 3 minutos

Siga só o único caminho de instalação que o texto oficial escreve.

Pré-requisito: esta máquina consegue executar npm e o diretório atual é um projeto que pode receber dependências. Confirme primeiro: npm install workflow vai mudar a lista de dependências e baixar um pacote. Se ainda não quiser mudar este projeto, não execute.

Local de instalação: abra um terminal na raiz do projeto, confirme esses efeitos colaterais e então execute:

npm install workflow

Tarefa de baixo risco: após instalar o pacote, não corra para iniciar um workflow numa rota ao vivo. Primeiro peça ao agente de código para abrir node_modules/workflow/docs em somente leitura, conferir se um guia local alinhado à versão atual aparece e achar a importação que o Next.js deve usar. Não grave arquivos nem envie pedidos para fora.

Sinal de sucesso: o pacote workflow aparece nas dependências do projeto, node_modules/workflow/docs abre localmente e o agente consegue apontar a importação oficial import { withWorkflow } from 'workflow/next'. Se inventar outro comando de instalação, volte ao comando oficial acima e tente de novo.

Casos de uso

Caso 1: ligar o invólucro oficial a um projeto Next.js. A importação que o texto dá é import { withWorkflow } from 'workflow/next'. Serve para quem já tem um projeto Next.js e quer conferir primeiro a entrada de configuração. Você pode primeiro pedir ao agente para marcar em somente leitura o arquivo de configuração a mudar e gravar depois da confirmação. Se o texto não expandir um objeto de configuração completo, pare em «usar essa importação»; não invente opções que não aparecem.

Caso 2: iniciar um workflow persistente a partir do servidor. O texto diz que em seguida dá para iniciar um workflow a partir de uma rota API, uma Server Action ou outro código de servidor. Serve para quem já instalou o pacote e tem uma entrada de servidor. Na primeira vez, peça ao agente para apontar de qual entrada de servidor existente você vai iniciar; não crie uma entrada de cliente sem explicação. O progresso é persistido e passos com falha são retentados; quantas tentativas e como abrir um painel de observabilidade não estão escritos — não invente.

Limites de uso

Só um comando oficial de instalação está escrito: npm install workflow. Não coloque um instalador que não aparece no caminho principal. As capacidades cobrem persistência, nova tentativa de passos com falha e observabilidade embutida para funções TypeScript e JavaScript; não provam uso em outras linguagens.

O local de início só está escrito como rotas API, Server Action ou outro código de servidor. Não inicie direto do navegador ou de um cliente sem nome. O caminho de docs local é node_modules/workflow/docs, para um agente de código ler guias alinhados à versão; não dá lista de clientes, então não trate isso como exclusivo de alguns assistentes.

Segredos, backends de fila e contas de observabilidade de produção não são desenvolvidos. A página oficial é