Visão geral

O @tunnelhub/sdk é a base pública para implementar automações no TunnelHub.

O que o SDK entrega

• fluxos prontos para integrações com e sem delta;

• persistência e comparação de estado em fluxos delta;

• logging operacional com estratégia inteligente;

• utilitários para parâmetros, sistemas, Data Stores e Sequences;

• utilitários de interceptação HTTP, validação e concorrência;

• suporte a build, testes locais e troubleshooting.

Instalação

npm install @tunnelhub/sdk

Pacote no npm: https://www.npmjs.com/package/@tunnelhub/sdk

Superfície pública atual

O entrypoint principal exporta, entre outros:

• DeltaIntegrationFlow

• BatchDeltaIntegrationFlow

• NoDeltaIntegrationFlow

• NoDeltaBatchIntegrationFlow

• AutomationParameter

• DataStore

• Sequences

• System

• setupInterceptor

• promiseWithConcurrency

• validateMetadata

O pacote também possui export separado para build tooling em @tunnelhub/sdk/building.

Runtime atual

• Node.js 18+ no pacote público;

• TypeScript como linguagem principal;

• integração com serviços AWS usados pela plataforma.

Dependendo do projeto, o runtime final publicado pode refletir as escolhas definidas em tunnelhub.yml e no tooling de build.

Skill para agentes

Além da documentação, existe um skill público chamado tunnelhub-sdk para ajudar agentes a trabalhar melhor com o SDK.

Esse skill é especialmente útil para:

• escolher o fluxo correto de integração;

• trabalhar com parâmetros, systems, data stores e sequences;

• entender logging, HTTP interceptor e utilitários;

• acelerar troubleshooting e implementação de testes.

Instalação:

npx skills add tunnelhub/agent-skills --skill tunnelhub-sdk -a opencode

Instalação global:

npx skills add tunnelhub/agent-skills --skill tunnelhub-sdk -a opencode -g

Como escolher um fluxo

• use No delta quando o processamento é unidirecional e sem comparação de estado;

• use No delta batch para alto volume unidirecional;

• use Delta quando precisa detectar insert, update e delete;

• use Batch delta quando precisa do modelo delta com processamento em lote.

Consulte Como escolher um flow, Fluxos de integração, Helpers de plataforma e Build, deploy e testes.