Publicação: SDK Node/TypeScript (@pilot-status/sdk)
Este guia descreve como publicar o SDK TypeScript/Node que vive em:
packages/sdk-node/
O pacote publicado no NPM é @pilot-status/sdk.
Link:
- https://www.npmjs.com/package/@pilot-status/sdk
Pré-requisitos
- Acesso de publish no NPM para o escopo
@pilot-status - Node.js >= 18
- Token de publish do NPM (recomendado em CI):
NPM_TOKEN
O que vai para o NPM
- O pacote publica apenas a pasta
dist/(verfilesnopackage.json) - O
prepublishOnlyrodanpm run build(TypeScript →dist/)
Passo a passo (manual)
1) Atualize a versão
Edite packages/sdk-node/package.json e incremente version seguindo SemVer.
Isso é obrigatório: o npm publish usa a versão do package.json. Se você não alterar, a publicação vai falhar com erro de versão já existente no registry.
2) Build e validação
Execute dentro de packages/sdk-node/:
npm ci
npm run build
3) Valide o conteúdo do pacote
npm publish --dry-run
Confirme que:
dist/está incluídomain,typeseexportsapontam paradist/*
4) Autentique no NPM (se necessário)
Em ambiente local:
npm login
Em CI (recomendado), configure:
npm config set //registry.npmjs.org/:_authToken "$NPM_TOKEN"
5) Publique (escopo público)
O pacote está configurado como público via publishConfig.access = "public".
npm publish
Verificações pós-publicação
- Conferir a versão publicada:
npm view @pilot-status/sdk version
- Instalar num projeto de teste:
npm i @pilot-status/sdk
Teste local sem publicar (tarball)
- Gere o tarball:
npm pack
- Em outro projeto Node:
npm i /caminho/para/pilot-status-sdk-0.1.2.tgz
Observações (boas práticas)
- Evite publicar sem build: o consumidor precisa do
dist/. - Se mudar endpoints/contratos, atualize também o
README.mde faça bump de versão coerente com SemVer.